artisynth.core.probes

Class WayPointProbe

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ModelAgentBase

artisynth.core.probes.Probe

artisynth.core.probes.OutputProbe

artisynth.core.probes.WayPointProbe

All Implemented Interfaces:

HasState, ModelAgent, ModelComponent, PostScannable, java.lang.Cloneable, java.lang.Iterable<WayPoint>, HasProperties, HierarchyNode, Scannable

public class WayPointProbe
extends OutputProbe
implements java.lang.Iterable<WayPoint>

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 int	WRITE_ALL_STATES
static int	WRITE_FIRST_STATE

Fields inherited from class artisynth.core.probes.Probe

myProps, useOldSaveMethod, writeStartStopTimeInSeconds

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Constructor Summary

Constructors

Constructor and Description
WayPointProbe()
WayPointProbe(RootModel model)

Method Summary

Modifier and Type	Method and Description
WayPoint	add(WayPoint newWay) Adds a waypoint to this probe, and returns any waypoint that previously occupied the same time slot.
void	apply(double t) Called at time t to apply this probe
void	clear() Clears all waypoints in this probe, except for the waypoint at time 0.
WayPoint	get(double t) Returns the waypoint at time t, or null if none exists.
WayPoint	getAfter(double t) Returns the next waypoint immediately after time t, or null if none exists.
WayPoint	getBreakPointAfter(double t) Returns the next breakpoint immediately after time t, or null if none exists.
WayPoint	getByIndex(int idx) Returns the waypoint at a specified positional index.
boolean	getCheckState()
WayPoint	getLastValid() Returns the last valid waypoint
java.util.Collection<WayPoint>	getPoints() Returns a Collection view of the waypoints in this probe.
RootModel	getRootModel() Returns the RootModel associated with this probe.
WayPoint	getValidAfter(double t) Returns the next valid waypoint immediately after time t, or null if none exists.
WayPoint	getValidBefore(double t) Returns the previous valid waypoint immediately before time t, or null if none exists.
WayPoint	getValidOnOrBefore(double t) Returns the valid waypoint immediately at or before time t, or null if none exists.
int	getWriteFlags()
void	invalidateAfterTime(double t) Invalidates all waypoints after a specified time.
void	invalidateInitialState()
boolean	isEventTime(double t) Queries whether time t is an event time for this probe.
java.util.Iterator<WayPoint>	iterator() Returns an interator for the waypoints in this probe
java.util.ListIterator<WayPoint>	listIterator() Returns a list interator for the waypoints in this probe
void	load() Loads waypoints and state from binary data in the attached file.
void	loadfrom(java.lang.String fileName) Loads waypoint data from the specified file.
double	maxEventTime() Queries the maximum event time in this probe.
double	nextEventTime(double t) Returns the time of the next probe event after time t.
int	numValid() Queries the number of currently valid waypoints in this probe.
void	postscan(java.util.Deque<ScanToken> tokens, CompositeComponent ancestor) Performs any required post-scanning for this component.
WayPoint	remove(double t) Removes and returns the waypoint at time t in this probe.
boolean	remove(WayPoint way) Removes a specified waypoint from this probe, if it exists.
void	resetInitialState()
void	save() Writes all waypoints and their state as binary data to the attached file if it exists.
void	saveas(java.lang.String fileName)
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
boolean	scanItem(ReaderTokenizer rtok, java.util.Deque<ScanToken> tokens)
void	setCheckState(boolean enable)
void	setWriteFlags(int flags)
int	size() Queries the number of waypoints in this probe.
void	updateInitialStateIfNecessary()
void	writeItems(java.io.PrintWriter pw, NumberFormat fmt, CompositeComponent ancestor) Write probe attributes to a PrintWriter

Methods inherited from class artisynth.core.probes.Probe

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

Methods inherited from class artisynth.core.modelbase.ModelAgentBase

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

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, copy, createTempFlag, disconnectFromHierarchy, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getSoftReferences, isFixed, isMarked, isScanning, isSelected, isWritable, 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 java.lang.Iterable

forEach, spliterator

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, isFixed, isMarked, isSelected, notifyParentOfChange, setFixed, setMarked, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.util.Scannable

isWritable

Field Detail

WRITE_FIRST_STATE

public static final int WRITE_FIRST_STATE

See Also:

Constant Field Values

WRITE_ALL_STATES

public static final int WRITE_ALL_STATES

See Also:

Constant Field Values

Constructor Detail

WayPointProbe

public WayPointProbe()

WayPointProbe

public WayPointProbe(RootModel model)

Method Detail

setCheckState

public void setCheckState(boolean enable)

getCheckState

public boolean getCheckState()

resetInitialState

public void resetInitialState()

invalidateInitialState

public void invalidateInitialState()

updateInitialStateIfNecessary

public void updateInitialStateIfNecessary()

add

public WayPoint add(WayPoint newWay)

Adds a waypoint to this probe, and returns any waypoint that previously occupied the same time slot.

Parameters:

newWay - new waypoint to add

Returns:

previous waypoint with the same time, if any

remove

public WayPoint remove(double t)

Removes and returns the waypoint at time t in this probe. If the waypoint does not exist, or if t <= 0, null is returned.

Parameters:

t - time of the waypoint that should be removed

Returns:

removed waypoint, or null

remove

public boolean remove(WayPoint way)

Removes a specified waypoint from this probe, if it exists.

Parameters:

way - waypoint to remove

Returns:

true if the waypoint exists and was removed

clear

public void clear()

Clears all waypoints in this probe, except for the waypoint at time 0.

nextEventTime

public double nextEventTime(double t)

Returns the time of the next probe event after time t.

Overrides:

nextEventTime in class Probe

Parameters:

t - reference time for the next event

Returns:

time of next probe event after t

isEventTime

public boolean isEventTime(double t)

Queries whether time t is an event time for this probe.

Overrides:

isEventTime in class Probe

Parameters:

t - time to query

Returns:

true if t is an event time

size

public int size()

Queries the number of waypoints in this probe.

Returns:

number of waypoints

numValid

public int numValid()

Queries the number of currently valid waypoints in this probe.

Returns:

number of valid waypoints

maxEventTime

public double maxEventTime()

Queries the maximum event time in this probe. This corresponds to the waypoint with the largest time value.

Returns:

largest waypoint time value

iterator

public java.util.Iterator<WayPoint> iterator()

Returns an interator for the waypoints in this probe

Specified by:

iterator in interface java.lang.Iterable<WayPoint>

Returns:

waypoint iterator

listIterator

public java.util.ListIterator<WayPoint> listIterator()

Returns a list interator for the waypoints in this probe

Returns:

waypoint iterator

getPoints

public java.util.Collection<WayPoint> getPoints()

Returns a Collection view of the waypoints in this probe.

Returns:

collection of all the waypoints

getAfter

public WayPoint getAfter(double t)

Returns the next waypoint immediately after time t, or null if none exists.

Parameters:

t - time after which next waypoint is sought

Returns:

next waypoint after t, or null

getValidAfter

public WayPoint getValidAfter(double t)

Returns the next valid waypoint immediately after time t, or null if none exists.

Parameters:

t - time after which next valid waypoint is sought

Returns:

next valid waypoint after t, or null

getLastValid

public WayPoint getLastValid()

Returns the last valid waypoint

Returns:

last valid waypoint

getBreakPointAfter

public WayPoint getBreakPointAfter(double t)

Returns the next breakpoint immediately after time t, or null if none exists.

Parameters:

t - time after which next breakpoint is sought

Returns:

next breakpoint after t, or null

getValidOnOrBefore

public WayPoint getValidOnOrBefore(double t)

Returns the valid waypoint immediately at or before time t, or null if none exists.

Parameters:

t - time at or before which valid waypoint is sought

Returns:

valid waypoint at or before t, or null

getValidBefore

public WayPoint getValidBefore(double t)

Returns the previous valid waypoint immediately before time t, or null if none exists.

Parameters:

t - time before which previous valid waypoint is sought

Returns:

previous valid waypoint before t, or null

get

public WayPoint get(double t)

Returns the waypoint at time t, or null if none exists.

Parameters:

t - time at which waypoint is sought

Returns:

waypoint at t, or null

getByIndex

public WayPoint getByIndex(int idx)

Returns the waypoint at a specified positional index.

Parameters:

idx - index of the requested waypoint

Returns:

waypoint at index ix

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds

apply

public void apply(double t)

Called at time t to apply this probe

Overrides:

apply in class OutputProbe

Parameters:

t - time at which probe is being applied

invalidateAfterTime

public void invalidateAfterTime(double t)

Invalidates all waypoints after a specified time.

Parameters:

t - time after which waypoints will be invalidated

save

public void save()
          throws java.io.IOException

Writes all waypoints and their state as binary data to the attached file if it exists.

Overrides:

save in class Probe

Throws:

java.io.IOException

saveas

public void saveas(java.lang.String fileName)

load

public void load()
          throws java.io.IOException

Loads waypoints and state from binary data in the attached file.

Overrides:

load in class Probe

Throws:

java.io.IOException

loadfrom

public void loadfrom(java.lang.String fileName)

Loads waypoint data from the specified file.

Parameters:

fileName - file to waypoints from

scan

public void scan(ReaderTokenizer rtok,
                 java.lang.Object ref)
          throws java.io.IOException

Description copied from class: ModelComponentBase

Scans this element from a ReaderTokenizer. The expected text format is assumed to be compatible with that produced by write.

Specified by:

scan in interface ModelComponent

Specified by:

scan in interface Scannable

Overrides:

scan in class Probe

Parameters:

rtok - Tokenizer from which to scan the element

ref - optional reference object which can be used for resolving references to other objects

Throws:

java.io.IOException - if an I/O or formatting error occured

postscan

public void postscan(java.util.Deque<ScanToken> tokens,
                     CompositeComponent ancestor)
              throws java.io.IOException

Description copied from interface: PostScannable

Performs any required post-scanning for this component. This involves handling any information whose processing was deferred during the scan() method and stored in the token queue. The most common use of this method is to resolve the paths of component references, which may not have been created at the time of the initial scan() call.

Specified by:

postscan in interface PostScannable

Overrides:

postscan in class ModelComponentBase

Parameters:

tokens - token information that was stored during scan().

ancestor - ancestor component with respect to which reference component paths are defined.

Throws:

java.io.IOException - if an error is encountered (such as a reference to a non-existent component)

scanItem

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

Throws:

java.io.IOException

getWriteFlags

public int getWriteFlags()

setWriteFlags

public void setWriteFlags(int flags)

writeItems

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

Description copied from class: Probe

Write probe attributes to a PrintWriter

Parameters:

pw - writer to which components are written

fmt - format for floating point numbers

ancestor - ancestor component which respect to which references are expressed

Throws:

java.io.IOException - if an I/O error occurred

getRootModel

public RootModel getRootModel()

Returns the RootModel associated with this probe.

Returns:

RootModel associated with this probe