artisynth.core.probes

Class ImagePlaneProbe

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ModelAgentBase

artisynth.core.probes.Probe

artisynth.core.probes.InputProbe

artisynth.core.probes.ImagePlaneProbe

All Implemented Interfaces:

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

public class ImagePlaneProbe
extends InputProbe
implements RenderableComponent, TransformableGeometry

Nested Class Summary

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

ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps
static RigidTransform3d	sagittalProjection

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.TransformableGeometry

TG_ARTICULATED, TG_DRAGGER, TG_PRESERVE_ORIENTATION, TG_SIMULATING

Constructor Summary

Constructors

Constructor and Description
ImagePlaneProbe(ModelComponent e, java.lang.String directoryName, java.lang.String fileName, double rate, double startTime, double stopTime, double ratio)

Method Summary

Modifier and Type	Method and Description
void	addTransformableDependencies(TransformGeometryContext context, int flags) Adds to context any transformable components which should be transformed as the same time as this component.
void	apply(double t) Called when the probe is being applied to a model
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.
PolygonalMesh	getMesh()
double	getRadius(ModelComponent e)
int	getRenderHints() Returns a bit code giving rendering hints about this renderable.
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.
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).
void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	setImage(double t)
void	setRenderProps(RenderProps props) Assigns a new set of render properties to this object.
void	transformGeometry(AffineTransform3dBase X) Applies an affine transformation to the geometry of this component.
void	transformGeometry(GeometryTransformer gtr, TransformGeometryContext context, int flags) Transforms the geometry of this component, using the geometry transformer gtr to transform its individual attributes.
void	updateBounds(Vector3d pmin, Vector3d pmax) Update the minimum and maximum points for this object.

Methods inherited from class artisynth.core.probes.InputProbe

isInput

Methods inherited from class artisynth.core.probes.Probe

createState, getAttachedFile, getAttachedFileName, getChildren, getDefaultScale, getDefaultStartTime, getDefaultStopTime, getDefaultUpdateInterval, getDuration, getInitialState, getProperty, getScale, getStartTime, getState, getStopTime, getTimelineTime, getTrack, getUpdateInterval, getVirtualTime, hasAttachedFile, hasChildren, hasState, isAttachedFileRelative, isCloneable, isEventTime, isPrintable, isScalable, isSettable, load, nextEventTime, print, save, scan, setAttachedFileName, setData, 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, isConnectedToHierarchy, isFixed, isMarked, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setSelected, 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, postscan, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, updateReferences

Methods inherited from interface maspack.properties.HasProperties

getProperty

Methods inherited from interface maspack.properties.HierarchyNode

getChildren, hasChildren

Methods inherited from interface maspack.util.Scannable

isWritable, write

Field Detail

sagittalProjection

public static final RigidTransform3d sagittalProjection

myProps

public static PropertyList myProps

Constructor Detail

ImagePlaneProbe

public ImagePlaneProbe(ModelComponent e,
                       java.lang.String directoryName,
                       java.lang.String fileName,
                       double rate,
                       double startTime,
                       double stopTime,
                       double ratio)

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 Probe

Returns:

static information for all exported properties

apply

public void apply(double t)

Description copied from class: Probe

Called when the probe is being applied to a model

Overrides:

apply in class InputProbe

getMesh

public PolygonalMesh getMesh()

setImage

public void setImage(double t)

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

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

transformGeometry

public void transformGeometry(AffineTransform3dBase X)

Description copied from interface: TransformableGeometry

Applies an affine transformation to the geometry of this component. This method should be equivalent to

 TransformGeometryContext.transform (this, X, 0);
 

Specified by:

transformGeometry in interface TransformableGeometry

Parameters:

X - affine transformation to apply to the component

transformGeometry

public void transformGeometry(GeometryTransformer gtr,
                              TransformGeometryContext context,
                              int flags)

Description copied from interface: TransformableGeometry

Transforms the geometry of this component, using the geometry transformer gtr to transform its individual attributes. The context argument supplies information about what other components are currently being transformed, and also allows the requesting of update actions to be performed after all transform called have completed. The context is also the usual entity that calls this method, from within its TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method. The argument flags provides flags to specify various conditions associated with the the transformation. At present, the available flags are TransformableGeometry.TG_SIMULATING and TransformableGeometry.TG_ARTICULATED.

This method is not usually called directly by applications. Instead, it is typically called from within the TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method of the context, which takes care of the various operations needed for a complete transform operation, including calling TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int) to collect other components that should be transformed, calling TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) for each component, notifying component parents that the geometry has changed, and calling any requested TransformGeometryActions. More details are given in the documentation for TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int).

TransformGeometryContext provides a number of static convenience transform methods which take care of building the context and calling apply() for a specified set of components.

This method should not generally call transformGeometry() for its descendant components. Instead, descendants needing transformation should be specified by adding them to the context in the method TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int).

Specified by:

transformGeometry in interface TransformableGeometry

Parameters:

gtr - transformer implementing the transform

context - context information, including what other components are being transformed

flags - specifies conditions associated with the transformation

addTransformableDependencies

public void addTransformableDependencies(TransformGeometryContext context,
                                         int flags)

Description copied from interface: TransformableGeometry

Adds to context any transformable components which should be transformed as the same time as this component. This will generally include descendant components, and may also include other components to which this component is connected in some way.

This method is generally called from with the TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method of a TransformGeometryContext.

Specified by:

addTransformableDependencies in interface TransformableGeometry

Parameters:

context - context information, to which the dependent components are added.

flags - specifies conditions associated with the transformation

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.

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

render

public 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.

updateBounds

public 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

getRadius

public double getRadius(ModelComponent e)