artisynth.core.renderables

Class TexturePlaneBase

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.mechmodels.DynamicComponentBase

artisynth.core.mechmodels.Frame

artisynth.core.renderables.TexturePlaneBase

All Implemented Interfaces:

CollidableDynamicComponent, ContactMaster, DynamicAgent, DynamicComponent, ForceEffector, FrameAttachable, HasSurfaceMesh, IsMarkable, MotionTargetComponent, PointAttachable, ComponentChangeListener, CompositeComponent, CopyableComponent, HasCoordinateFrame, HasNumericState, HasPoseComponent, HasPosition, IndexedComponentList, ModelComponent, PostScannable, RenderableComponent, Traceable, TransformableGeometry, ScalableUnits, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

Direct Known Subclasses:

DicomPlaneViewer, ImageViewer

public abstract class TexturePlaneBase
extends Frame
implements TransformableGeometry, HasSurfaceMesh

Base class for texture-based planes, supports affine transforms and frame-markers

Nested Class Summary

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

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

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

CompositeComponent.NavpanelDisplay

Field Summary

Fields inherited from class artisynth.core.mechmodels.Frame

dynamicVelInWorldCoords, myProps, myRenderFrame

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface artisynth.core.modelbase.TransformableGeometry

TG_ARTICULATED, TG_DRAGGER, TG_PRESERVE_ORIENTATION, TG_SIMULATING

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Fields inherited from interface artisynth.core.modelbase.CopyableComponent

COPY_REFERENCES, REST_POSITION

Method Summary

Modifier and Type	Method and Description
TexturePlaneBase	copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap) Create a copy of this component.
Marker	createMarker(Line ray) Creates a FrameMarker attached to this frame and adds it to the frame's markers list.
FrameMarker	createMarker(Point3d pnt, boolean project) Create a marker for the image, optionally projecting to the surface of the image
PolygonalMesh	getSurfaceMesh() Returns the surface mesh associated with this component, or null if no mesh exists.
PolygonalMesh[]	getSurfaceMeshes() Returns an array listing all the (non-null) surface meshes associated with this component, or a zero-length array if there are none.
boolean	hasState() Queries if this component has state.
boolean	isDuplicatable() Returns true if this component can be duplicated.
java.util.Iterator<ModelComponent>	iterator()
int	numSurfaceMeshes() Returns the number of surfaces meshes associated with this component, or 0 if no meshes exist.
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	scaleDistance(double s) Scales all distance coordinates.
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.mechmodels.Frame

add, add1DConstraintBlocks, add2DConstraintBlocks, addAttachedFrame, addAttachedFrame, addAttachedFrameWorld, addEffectiveFrameMass, addEffectivePointMass, addExternalForce, addForce, addForce, addFrameForce, addMarker, addMarker, addMarker, addMarkerWorld, addPointForce, addPointForce, addPosImpulse, addPosJacobian, addRelativeVelocity, addScaledExternalForce, addSolveBlock, addSolveBlocks, addTargetJacobian, addToPointVelocity, addTransformableDependencies, addVelJacobian, applyExternalForces, applyForces, applyGravity, canAddMarker, clearAttachedFrames, clearMarkers, collectMasterComponents, componentChanged, computeAppliedWrench, computeForceOnMasters, computeFrameLocation, computeFramePosition, computeFramePosVel, computeFrameVelocity, computePointCoriolis, computePointLocation, computePointPosition, computePointPosVel, computePointVelocity, createFrameAttachment, createMarker, createMassBlock, createPointAttachment, createRenderProps, findComponent, get, get, getAllPropertyInfo, getAttachedFrames, getAxisDrawStyle, getAxisLength, getBodyForce, getBodyVelocity, getBodyVelState, getByNumber, getChildren, getCopyReferences, getEffectiveMass, getEffectiveMass, getEffectiveMassForces, getExternalForce, getForce, getForce, getForce, getFrameDamping, getFrameDampingMode, getFrameMarkers, getJacobianType, getMarkers, getMass, getMass, getMoment, getNavpanelDisplay, getNumberLimit, getOrientation, getOrientation, getPosDerivative, getPose, getPose, getPosition, getPosState, getPosStateSize, getRenderFrame, getRotaryDamping, getRotaryDampingMode, getRotation, getSelection, getState, getTargetActivity, getTargetOrientation, getTargetPos, getTargetPose, getTargetPosition, getTargetVel, getTargetVelocity, getTraceablePositionProperty, getTraceables, getTransForce, getVelocity, getVelocity, getVelState, getVelStateSize, getWorldVelState, hasChildren, hasForce, hierarchyContainsReferences, indexOf, isMassConstant, mulInverseEffectiveMass, numComponents, postscan, remove, removeAttachedFrame, removeMarker, resetEffectiveMass, resetTargets, scaleMass, scan, setAxisDrawStyle, setAxisLength, setBodyVelocity, setContactConstraint, setExternalForce, setForce, setForce, setFrameDamping, setFrameDampingMode, setNavpanelDisplay, setOrientation, setPose, setPosition, setPosState, setRandomForce, setRandomPosState, setRandomVelState, setRotaryDamping, setRotaryDampingMode, setRotation, setState, setState, setTargetActivity, setTargetOrientation, setTargetPos, setTargetPose, setTargetPosition, setTargetVel, setTargetVelocity, setVelocity, setVelocity, setVelState, transformPose, updateAttachmentPosStates, updateNameMap, velocityLimitExceeded, zeroExternalForces, zeroForces

Methods inherited from class artisynth.core.mechmodels.DynamicComponentBase

addAttachmentRequest, addConstrainer, addMasterAttachment, connectToHierarchy, disconnectFromHierarchy, getAttachment, getConstrainers, getInverseMass, getMasterAttachments, getSolveIndex, isActive, isAttached, isControllable, isDynamic, isParametric, removeAttachmentRequest, removeConstrainer, removeMasterAttachment, setAttached, setSolveIndex

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

defaultRenderPropsAreNull, getRenderHints, getRenderProps, isSelectable, isVisible, numSelectionQueriesNeeded, setRenderProps, setVisible, updateRenderProps

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface artisynth.core.modelbase.TransformableGeometry

addTransformableDependencies, transformPriority

Methods inherited from interface artisynth.core.mechmodels.HasSurfaceMesh

computeRayIntersection

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, 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

Methods inherited from interface maspack.render.IsSelectable

getSelection, isSelectable, numSelectionQueriesNeeded

Methods inherited from interface maspack.render.IsRenderable

getRenderHints

Methods inherited from interface maspack.render.HasRenderProps

createRenderProps, getRenderProps, setRenderProps

Methods inherited from interface artisynth.core.mechmodels.DynamicComponent

addAttachmentRequest, removeAttachmentRequest

Methods inherited from interface artisynth.core.mechmodels.DynamicAgent

addConstrainer, addMasterAttachment, getAttachment, getConstrainers, getInverseMass, getMasterAttachments, getSolveIndex, isActive, isAttached, isControllable, isDynamic, isParametric, removeConstrainer, removeMasterAttachment, setAttached, setSolveIndex

Methods inherited from interface artisynth.core.modelbase.HasNumericState

advanceState, getAuxVarDerivative, getAuxVarState, getStateVersion, numAuxVars, requiresAdvance, setAuxVarState

Methods inherited from interface artisynth.core.mechmodels.ContactMaster

isControllable

Methods inherited from interface artisynth.core.modelbase.CompositeComponent

recursivelyFind

Method Detail

scaleDistance

public void scaleDistance(double s)

Description copied from interface: ScalableUnits

Scales all distance coordinates.

Specified by:

scaleDistance in interface ScalableUnits

Overrides:

scaleDistance in class Frame

Parameters:

s - scaling factor

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

Overrides:

transformGeometry in class DynamicComponentBase

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

Overrides:

transformGeometry in class Frame

Parameters:

gtr - transformer implementing the transform

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

flags - specifies conditions associated with the transformation

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

Overrides:

prerender in class Frame

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

Overrides:

render in class Frame

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

Overrides:

updateBounds in class Frame

Parameters:

pmin - minimum point

pmax - maximum point

getSurfaceMesh

public PolygonalMesh getSurfaceMesh()

Description copied from interface: HasSurfaceMesh

Returns the surface mesh associated with this component, or null if no mesh exists. If multiple surface meshes exist, this should be first one in the array returned by HasSurfaceMesh.getSurfaceMeshes().

Specified by:

getSurfaceMesh in interface HasSurfaceMesh

Returns:

component's (primary) surface mesh

numSurfaceMeshes

public int numSurfaceMeshes()

Description copied from interface: HasSurfaceMesh

Returns the number of surfaces meshes associated with this component, or 0 if no meshes exist. If HasSurfaceMesh.getSurfaceMesh() returns null, then this method should return 0.

Specified by:

numSurfaceMeshes in interface HasSurfaceMesh

Returns:

number of surface meshes associated with this component

getSurfaceMeshes

public PolygonalMesh[] getSurfaceMeshes()

Description copied from interface: HasSurfaceMesh

Returns an array listing all the (non-null) surface meshes associated with this component, or a zero-length array if there are none. If HasSurfaceMesh.getSurfaceMesh() returns null, then a zero-length array should be returned.

Specified by:

getSurfaceMeshes in interface HasSurfaceMesh

Returns:

surface meshes associated with this component

createMarker

public FrameMarker createMarker(Point3d pnt,
                                boolean project)

Create a marker for the image, optionally projecting to the surface of the image

Parameters:

pnt - location to add marker

project - project to image surface

Returns:

created marker

createMarker

public Marker createMarker(Line ray)

Description copied from class: Frame

Creates a FrameMarker attached to this frame and adds it to the frame's markers list. If the frame is an instance of HasSurfaceMesh, the marker's position is determined the nearest intersection of the specified ray and the mesh, with null being returned if there is no intersection. Otherwise, the marker's position is set to the frame's origin.

Specified by:

createMarker in interface IsMarkable

Overrides:

createMarker in class Frame

Parameters:

ray - to line intersect with the frame's surface mesh to determine the marker location

Returns:

created marker, or null if there is no mesh-ray intersection

iterator

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

hasState

public boolean hasState()

Description copied from class: DynamicComponentBase

Queries if this component has state. Structure change events involving components that have state will cause the current state history of of the system to be cleared.

Specified by:

hasState in interface HasNumericState

Specified by:

hasState in interface ModelComponent

Overrides:

hasState in class DynamicComponentBase

Returns:

true if this component has state

isDuplicatable

public boolean isDuplicatable()

Description copied from interface: CopyableComponent

Returns true if this component can be duplicated. Duplication means that we can expect to be able to make a complete copy of the component along with all it's external references. This method should return true if and only if CopyableComponent.getCopyReferences(java.util.List<artisynth.core.modelbase.ModelComponent>, artisynth.core.modelbase.ModelComponent) returns true.

This method is not currently used. It is intended to provide a faster way of determining if a component can be duplicated, without having to use CopyableComponent.getCopyReferences(java.util.List<artisynth.core.modelbase.ModelComponent>, artisynth.core.modelbase.ModelComponent) to build the list of copy references.

Specified by:

isDuplicatable in interface CopyableComponent

Overrides:

isDuplicatable in class Frame

Returns:

true if this component can be duplicated.

copy

public TexturePlaneBase copy(int flags,
                             java.util.Map<ModelComponent,ModelComponent> copyMap)

Description copied from interface: CopyableComponent

Create a copy of this component. If COPY_REFERENCES is set in flags, then any component referenced by this component should itself be set to a copy. This should be done first checking copyMap for an existing copy of the referenced component. If there is no existing copy, then a copy should be created by calling copy recursively and adding the new copy to copyMap.

Specified by:

copy in interface CopyableComponent

Overrides:

copy in class Frame

Parameters:

flags - flags to control the copying

copyMap - map to possible existing instances of referenced components

Returns:

copy of this component