artisynth.core.workspace

Class TransparencyProbe

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ModelAgentBase

artisynth.core.probes.Probe

artisynth.core.probes.NumericProbeBase

artisynth.core.probes.NumericDataFunctionProbe

artisynth.core.probes.NumericControlProbe

artisynth.core.workspace.TransparencyProbe

All Implemented Interfaces:

Displayable, CopyableComponent, HasState, ModelAgent, ModelComponent, PostScannable, java.lang.Cloneable, HasProperties, HierarchyNode, Scannable

public class TransparencyProbe
extends NumericControlProbe

Input probe to control the visibility of one or more renderable objects by adjusting the alpha value of their render properties.

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 inherited from class artisynth.core.probes.NumericControlProbe

EXPLICIT_TIME, myProps

Fields inherited from class artisynth.core.probes.NumericProbeBase

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 artisynth.core.modelbase.CopyableComponent

COPY_REFERENCES, REST_POSITION

Constructor Summary

Constructors

Constructor and Description
TransparencyProbe()
TransparencyProbe(java.util.Collection<? extends RenderableComponent> comps, double startTime, double stopTime)
TransparencyProbe(RenderableComponent[] comps, double startTime, double stopTime)
TransparencyProbe(RenderableComponent comp, double startTime, double stopTime)

Method Summary

Modifier and Type	Method and Description
void	addFadeIn(double t0, double t1)
void	addFadeOut(double t0, double t1)
void	addKnot(double t0, double value)
void	applyData(VectorNd vec, double t, double trel) Applies the current numeric data of this probe, as input in the argument vec, and uses it to update the simulation for either the current absolute time t or probe relative time trel.
boolean	scanItem(ReaderTokenizer rtok, java.util.Deque<ScanToken> tokens)
void	writeItems(java.io.PrintWriter pw, NumberFormat fmt, CompositeComponent ancestor) Write probe attributes to a PrintWriter

Methods inherited from class artisynth.core.probes.NumericControlProbe

addData, addData, addData, addData, addData, addData, apply, clone, copy, createNumericList, getAllPropertyInfo, getCopyReferences, getExtendData, getInput, isInput, isSettable, load, loadEmpty, read, save, scan, setAttachedFileName, setAttachedFileName, setData, setExtendData, setVsize, setVsize, write

Methods inherited from class artisynth.core.probes.NumericDataFunctionProbe

createState, getDataFunction, getInitialState, getState, hasState, isCloneable, isDuplicatable, setDataFunction, setState

Methods inherited from class artisynth.core.probes.NumericProbeBase

applyDefaultDisplayRanges, clearData, 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, isEmpty, isPrintable, isSmallDisplayVisible, isTraceVisible, isValidVariableName, isWritable, loadFromMatlab, print, 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

getAttachedFile, getAttachedFileName, getChildren, getClippedVirtualTime, getDefaultScale, getDefaultStartTime, getDefaultStopTime, getDefaultUpdateInterval, getDuration, getExportFile, getExportFileName, getFileFromPath, getImportFile, getImportFileInfo, getImportFileName, getPathFromFile, getProperty, getScale, getStartTime, getStopTime, getTimelineTime, getTrack, getUpdateInterval, getVirtualTime, hasAttachedFile, hasChildren, isAttachedFileRelative, isEventTime, isScalable, nextEventTime, setExportFileName, setImportFileName, setInterval, setName, setScalable, setStartStopTimes, setStartTime, 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, postscan, 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, isFixed, isMarked, isSelected, notifyParentOfChange, 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

Constructor Detail

TransparencyProbe

public TransparencyProbe()

TransparencyProbe

public TransparencyProbe(RenderableComponent comp,
                         double startTime,
                         double stopTime)

TransparencyProbe

public TransparencyProbe(java.util.Collection<? extends RenderableComponent> comps,
                         double startTime,
                         double stopTime)

TransparencyProbe

public TransparencyProbe(RenderableComponent[] comps,
                         double startTime,
                         double stopTime)

Method Detail

addFadeIn

public void addFadeIn(double t0,
                      double t1)

addFadeOut

public void addFadeOut(double t0,
                       double t1)

addKnot

public void addKnot(double t0,
                    double value)

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

Overrides:

writeItems in class NumericControlProbe

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

scanItem

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

Overrides:

scanItem in class NumericControlProbe

Throws:

java.io.IOException

applyData

public void applyData(VectorNd vec,
                      double t,
                      double trel)

Description copied from class: NumericControlProbe

Applies the current numeric data of this probe, as input in the argument vec, and uses it to update the simulation for either the current absolute time t or probe relative time trel. The size of vec will equal the vector size of the probe (as returned by NumericProbeBase.getVsize(). Probe relative time is determined from the probe's start time and scale factor using

 trel = (t - startTime)/scale 

.

Overrides:

applyData in class NumericControlProbe

Parameters:

vec - supplies the current numeric data

t - absolute time (seconds)

trel - probe relative time