artisynth.core.probes

Class TracingProbe

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ModelAgentBase

artisynth.core.probes.Probe

artisynth.core.probes.NumericProbeBase

artisynth.core.probes.NumericOutputProbe

artisynth.core.probes.TracingProbe

All Implemented Interfaces:

Displayable, CopyableComponent, HasState, ModelAgent, ModelComponent, PostScannable, RenderableComponent, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

Direct Known Subclasses:

PointTracingProbe, VectorTracingProbe

public abstract class TracingProbe
extends NumericOutputProbe
implements RenderableComponent

Nested Class Summary

Nested classes/interfaces inherited from class artisynth.core.probes.Probe

Probe.ExportProps, Probe.ImportExportFileInfo

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

ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps

Fields inherited from class artisynth.core.probes.NumericProbeBase

EXPLICIT_TIME, mySmallDisplay

Fields inherited from class artisynth.core.probes.Probe

useOldSaveMethod, writeStartStopTimeInSeconds

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Fields inherited from interface artisynth.core.modelbase.CopyableComponent

COPY_REFERENCES, REST_POSITION

Constructor Summary

Constructors

Constructor and Description
TracingProbe()
TracingProbe(Property[] props, double interval)
TracingProbe(Property[] props, double interval, double ymin, double ymax)
TracingProbe(Property prop, double interval)

Method Summary

Modifier and Type	Method and Description
static TracingProbe	create(Traceable host, java.lang.String traceableName)
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
HasProperties	getHost(int idx) Returns the host associated with the idx-th property in this probe, or null if there is no such property.
int	getRenderHints() Returns a bit code giving rendering hints about this renderable.
double	getRenderInterval()
RenderProps	getRenderProps() Returns the render properities for this object.
void	getSelection(java.util.LinkedList<java.lang.Object> list, int qid) Append to list the component (or components) associated with the qid-th selection query issued by this component's render method.
boolean	isSelectable() Returns true if this object is in fact selectable.
boolean	isTracing(HasProperties host, java.lang.String propName) Returns true if this tracing probe is tracing the single property propName associated with the specified host.
int	numSelectionQueriesNeeded() If this selectable manages its own selection (by issuing selection queries within its render method), then this method should return the maximum number of selection queries that will be required.
void	prerender(RenderList list) Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates).
abstract void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	setRenderInterval(double h)
void	setRenderProps(RenderProps props) Assigns a new set of render properties to this object.
abstract void	updateBounds(Vector3d pmin, Vector3d pmax) Update the minimum and maximum points for this object.

Methods inherited from class artisynth.core.probes.NumericOutputProbe

apply, clone, copy, getCopyReferences, getOutput, getShowHeader, getShowTime, isDuplicatable, load, postscan, save, scan, scanItem, set, set, setAttachedFileName, setAttachedFileName, setOutputProperties, setShowHeader, setShowTime, write, writeData, writeItems

Methods inherited from class artisynth.core.probes.NumericProbeBase

addData, applyDefaultDisplayRanges, clearData, createNumericList, decreaseDisplayRanges, dispose, export, getAttachedProperties, getData, getDefaultDisplayMax, getDefaultDisplayMin, getDefaultDisplayRange, getDisplay, getDrivers, getExportFileInfo, getExportProps, getFormat, getInterpolation, getInterpolationOrder, getLegend, getMatlabName, getMinMaxValues, getNumericList, getOrderedTraceIndex, getPlotTraceInfo, getRange, getRange, getTraceColor, getTraceLabel, getTraceManager, getValues, getVariables, getVsize, importData, importText, increaseDisplayRanges, isCloneable, isDisplayable, isEmpty, isPrintable, isSmallDisplayVisible, isTraceVisible, isValidVariableName, isWritable, loadFromMatlab, print, read, removeDisplay, removeLegend, resetTraceColors, resetTraceOrder, saveToMatlab, scaleNumericList, setDefaultDisplayRange, setDefaultDisplayRange, setFormat, setInterpolation, setInterpolationOrder, setLegend, setLegendLabels, setScale, setSmallDisplayVisible, setTraceColor, setTraceLabel, setTraceOrder, setTraceVisible, setValues, smoothWithMovingAverage, smoothWithSavitzkyGolay, swapPlotTraceOrder, updateDisplays, updateDisplays, updateDisplaysForPropertyChanges, updateDisplaysWithoutAutoRanging, writeText

Methods inherited from class artisynth.core.probes.Probe

createState, getAttachedFile, getAttachedFileName, getChildren, getClippedVirtualTime, getDefaultScale, getDefaultStartTime, getDefaultStopTime, getDefaultUpdateInterval, getDuration, getExportFile, getExportFileName, getFileFromPath, getImportFile, getImportFileInfo, getImportFileName, getInitialState, getPathFromFile, getProperty, getScale, getStartTime, getState, getStopTime, getTimelineTime, getTrack, getUpdateInterval, getVirtualTime, hasAttachedFile, hasChildren, hasState, isAttachedFileRelative, isEventTime, isInput, isScalable, isSettable, nextEventTime, setAttachedFileName, setData, setExportFileName, setImportFileName, setInterval, setName, setScalable, setStartStopTimes, setStartTime, setState, setStopTime, setTrack, setUpdateInterval

Methods inherited from class artisynth.core.modelbase.ModelAgentBase

finalize, getModel, initialize, isActive, setActive, setModel, setModelFromComponent, write

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, connectToHierarchy, createTempFlag, disconnectFromHierarchy, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getSoftReferences, isFixed, isMarked, isScanning, isSelected, makeValidName, makeValidName, notifyParentOfChange, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, updateReferences

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

myProps

public static PropertyList myProps

Constructor Detail

TracingProbe

public TracingProbe()

TracingProbe

public TracingProbe(Property[] props,
                    double interval,
                    double ymin,
                    double ymax)

TracingProbe

public TracingProbe(Property[] props,
                    double interval)

TracingProbe

public TracingProbe(Property prop,
                    double interval)

Method Detail

getAllPropertyInfo

public PropertyList getAllPropertyInfo()

Description copied from interface: HasProperties

Returns a list giving static information about all properties exported by this object.

Specified by:

getAllPropertyInfo in interface HasProperties

Overrides:

getAllPropertyInfo in class NumericOutputProbe

Returns:

static information for all exported properties

getRenderInterval

public double getRenderInterval()

setRenderInterval

public void setRenderInterval(double h)

isTracing

public boolean isTracing(HasProperties host,
                         java.lang.String propName)

Returns true if this tracing probe is tracing the single property propName associated with the specified host. If host is null, then the any host will match.

getHost

public HasProperties getHost(int idx)

Returns the host associated with the idx-th property in this probe, or null if there is no such property.

getRenderProps

public RenderProps getRenderProps()

Description copied from interface: HasRenderProps

Returns the render properities for this object. If no render properties are assigned, this routines returns null.

Specified by:

getRenderProps in interface HasRenderProps

Returns:

current render properties for this object

setRenderProps

public void setRenderProps(RenderProps props)

Description copied from interface: HasRenderProps

Assigns a new set of render properties to this object. An argument of null will remove render properties from this object.

Specified by:

setRenderProps in interface HasRenderProps

Parameters:

props - new render properties for this object

createRenderProps

public RenderProps createRenderProps()

Description copied from interface: HasRenderProps

Factory method to create render properties appropriate to this object.

Specified by:

createRenderProps in interface HasRenderProps

Returns:

new render properties for this object

prerender

public void prerender(RenderList list)

Description copied from interface: IsRenderable

Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates). The object may add internal objects to the list of objects being rendered, by calling

list.addIfVisible (obj);

for each of the objects in question.

Specified by:

prerender in interface IsRenderable

Parameters:

list - list of objects to be rendered

updateBounds

public abstract void updateBounds(Vector3d pmin,
                                  Vector3d pmax)

Description copied from interface: IsRenderable

Update the minimum and maximum points for this object. In an x-y-z coordinate system with x directed to the right and y directed upwards, the minimum and maximum points can be thought of as defining the left-lower-far and right-upper-near corners of a bounding cube. This method should only reduce the elements of the minimum point and increase the elements of the maximum point, since it may be used as part of an iteration to determine the bounding cube for several different objects.

Specified by:

updateBounds in interface IsRenderable

Parameters:

pmin - minimum point

pmax - maximum point

render

public abstract void render(Renderer renderer,
                            int flags)

Description copied from interface: IsRenderable

Render this object using the functionality of the supplied Renderer.

Specified by:

render in interface IsRenderable

Parameters:

renderer - provides the functionality used to perform the rendering.

flags - flags that may be used to control different aspects of the rendering. Flags are defined in Renderer and currently include Renderer.HIGHLIGHT and Renderer.SORT_FACES.

isSelectable

public boolean isSelectable()

Description copied from interface: IsSelectable

Returns true if this object is in fact selectable.

Specified by:

isSelectable in interface IsSelectable

Returns:

true if this object is selectable

numSelectionQueriesNeeded

public int numSelectionQueriesNeeded()

Description copied from interface: IsSelectable

If this selectable manages its own selection (by issuing selection queries within its render method), then this method should return the maximum number of selection queries that will be required. Otherwise, this method should return -1.

Specified by:

numSelectionQueriesNeeded in interface IsSelectable

Returns:

maximum number of selection queries needed by this component, or -1 if this component does not manage its own selection.

getSelection

public void getSelection(java.util.LinkedList<java.lang.Object> list,
                         int qid)

Description copied from interface: IsSelectable

Append to list the component (or components) associated with the qid-th selection query issued by this component's render method. This will only be called if this component manages its own selection (i.e., the number nums returned by IsSelectable.numSelectionQueriesNeeded() is positive), and qid will in turn be a number between 0 and nums-1.

Specified by:

getSelection in interface IsSelectable

Parameters:

list - selected objects are appended to the end of this list

qid - index of the selection query

getRenderHints

public int getRenderHints()

Description copied from interface: IsRenderable

Returns a bit code giving rendering hints about this renderable. Current bit codes include TRANSPARENT and TWO_DIMENSIONAL.

Specified by:

getRenderHints in interface IsRenderable

Returns:

bit code of rendering hints.

create

public static TracingProbe create(Traceable host,
                                  java.lang.String traceableName)