public abstract class TexturePlaneBase extends Frame implements CompositeComponent, TransformableGeometry, HasSurfaceMesh, IsMarkable
CompositeComponent.NavpanelDisplayModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibilitydynamicVelInWorldCoords, myProps, myRenderFrameenforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNamesTG_ARTICULATED, TG_DRAGGER, TG_PRESERVE_ORIENTATION, TG_SIMULATINGCOPY_REFERENCES, REST_POSITIONTRANSPARENT, TWO_DIMENSIONAL| Modifier and Type | Method and Description |
|---|---|
boolean |
addMarker(Marker mkr)
Adds the marker to the component (or potentially somewhere within the component hierarchy)
|
boolean |
canAddMarker(Marker mkr)
Checks whether or not the marker can be added to the component (or potentially somewhere within the component hierarchy),
without actually adding it.
|
void |
componentChanged(ComponentChangeEvent e)
Notifies this composite component that a change has occured within one or
more of its descendants.
|
TexturePlaneBase |
copy(int flags,
java.util.Map<ModelComponent,ModelComponent> copyMap)
Create a copy of this component.
|
Marker |
createMarker(Line ray)
Creates a marker along a ray of intersection
|
Marker |
createMarker(Point3d pnt)
Creates a marker at a specific location
|
FrameMarker |
createMarker(Point3d pnt,
boolean project)
Create a marker for the image, optionally projecting to the surface of the image
|
ModelComponent |
findComponent(java.lang.String path)
Recursively searches for a subcomponent of this ModelComponent,
identified by a path of component names.
|
ModelComponent |
get(int idx)
Returns a specific subcomponent of this ModelComponent, identified by
index.
|
ModelComponent |
get(java.lang.String nameOrNumber)
Returns a specific subcomponent of this ModelComponent, identified by
name or string representation of the subcomponent's number
|
ModelComponent |
getByNumber(int num)
Returns a specific subcomponent of this ModelComponent, identified by
number.
|
java.util.Iterator<? extends HierarchyNode> |
getChildren() |
RenderableComponentList<? extends FrameMarker> |
getMarkers() |
CompositeComponent.NavpanelDisplay |
getNavpanelDisplay()
Returns the DisplayMode for this component.
|
int |
getNumberLimit()
Returns the current upper limit for numbers among all subcomponents in
this composite.
|
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 |
hasChildren() |
boolean |
hasState()
Queries if this component has state.
|
boolean |
hierarchyContainsReferences()
Returns true if the component hierarchy formed by this component and its
descendents is closed with respect to references.
|
int |
indexOf(ModelComponent comp)
Returns the index of a specified subcomponent, or -1 if that the
component is not present.
|
java.util.Iterator<ModelComponent> |
iterator() |
int |
numComponents()
Returns the number of components in this CompositeComponent.
|
int |
numSurfaceMeshes()
Returns the number of surfaces meshes associated with this
component, or 0 if no meshes exist.
|
void |
postscan(java.util.Deque<ScanToken> tokens,
CompositeComponent ancestor)
Performs any required post-scanning for this component.
|
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 |
scan(ReaderTokenizer rtok,
java.lang.Object ref)
Scans this element from a ReaderTokenizer.
|
void |
setDisplayMode(CompositeComponent.NavpanelDisplay mode)
Sets the display mode for this component.
|
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.
|
void |
updateNameMap(java.lang.String newName,
java.lang.String oldName,
ModelComponent comp) |
add1DConstraintBlocks, add2DConstraintBlocks, addEffectiveFrameMass, addEffectivePointMass, addExternalForce, addForce, addForce, addFrameForce, addPointForce, addPointForce, addPosImpulse, addPosJacobian, addRelativeVelocity, addScaledExternalForce, addSolveBlock, addSolveBlocks, addTargetJacobian, addToPointVelocity, addTransformableDependencies, addVelJacobian, applyExternalForces, applyForces, applyGravity, collectMasterComponents, computeAppliedWrench, computeForceOnMasters, computeFrameLocation, computeFramePosition, computeFramePosVel, computeFrameVelocity, computePointCoriolis, computePointLocation, computePointPosition, computePointPosVel, computePointVelocity, createFrameAttachment, createMassBlock, createPointAttachment, createRenderProps, getAllPropertyInfo, getAxisDrawStyle, getAxisLength, getBodyForce, getBodyVelocity, getBodyVelState, getCopyReferences, getEffectiveMass, getEffectiveMass, getEffectiveMassForces, getExternalForce, getForce, getForce, getForce, getFrameDamping, getFrameDampingMode, getFrameMarkers, getJacobianType, getMass, getMass, getMoment, 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, hasForce, isDuplicatable, isMassConstant, mulInverseEffectiveMass, resetEffectiveMass, resetTargets, scaleMass, setAxisDrawStyle, setAxisLength, setBodyVelocity, setContactConstraint, setExternalForce, setForce, setForce, setFrameDamping, setFrameDampingMode, setOrientation, setPose, setPosition, setPosState, setRandomForce, setRandomPosState, setRandomVelState, setRotaryDamping, setRotaryDampingMode, setRotation, setState, setState, setTargetActivity, setTargetOrientation, setTargetPos, setTargetPose, setTargetPosition, setTargetVel, setTargetVelocity, setVelocity, setVelocity, setVelState, transformPose, updateAttachmentPosStates, velocityLimitExceeded, zeroExternalForces, zeroForcesaddAttachmentRequest, addConstrainer, addMasterAttachment, connectToHierarchy, disconnectFromHierarchy, getAttachment, getConstrainers, getInverseMass, getMasterAttachments, getSolveIndex, isActive, isAttached, isControllable, isDynamic, isParametric, removeAttachmentRequest, removeConstrainer, removeMasterAttachment, setAttached, setSolveIndexdefaultRenderPropsAreNull, getRenderHints, getRenderProps, isSelectable, isVisible, numSelectionQueriesNeeded, setRenderProps, setVisible, updateRenderPropscheckFlag, 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, writeequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitrecursivelyFindconnectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, isFixed, isMarked, isSelected, notifyParentOfChange, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferencesgetAllPropertyInfo, getPropertyisWritable, writeaddTransformableDependencies, transformPriorityaddAttachmentRequest, removeAttachmentRequestaddConstrainer, addMasterAttachment, getAttachment, getConstrainers, getInverseMass, getMasterAttachments, getSolveIndex, isActive, isAttached, isControllable, isDynamic, isParametric, removeConstrainer, removeMasterAttachment, setAttached, setSolveIndexadvanceState, getAuxVarDerivative, getAuxVarState, getStateVersion, numAuxVars, requiresAdvance, setAuxVarStateisControllablepublic boolean addMarker(Marker mkr)
IsMarkableaddMarker in interface IsMarkablemkr - marker to addpublic boolean canAddMarker(Marker mkr)
IsMarkablecanAddMarker in interface IsMarkablemkr - marker to addIsMarkable.addMarker(Marker)public Marker createMarker(Point3d pnt)
IsMarkablecreateMarker in interface IsMarkablepnt - world location for markerpublic void scaleDistance(double s)
ScalableUnitsscaleDistance in interface ScalableUnitsscaleDistance in class Frames - scaling factorpublic void transformGeometry(AffineTransform3dBase X)
TransformableGeometryTransformGeometryContext.transform (this, X, 0);
transformGeometry in interface TransformableGeometrytransformGeometry in class DynamicComponentBaseX - affine transformation to apply to the componentpublic void transformGeometry(GeometryTransformer gtr, TransformGeometryContext context, int flags)
TransformableGeometrygtr 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).
transformGeometry in interface TransformableGeometrytransformGeometry in class Framegtr - transformer implementing the transformcontext - context information, including what other components
are being transformedflags - specifies conditions associated with the transformationpublic void prerender(RenderList list)
IsRenderablelist.addIfVisible (obj);
for each of the objects in question.prerender in interface IsRenderableprerender in class Framelist - list of objects to be renderedpublic void render(Renderer renderer, int flags)
IsRenderableRenderer.render in interface IsRenderablerender in class Framerenderer - 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.public void updateBounds(Vector3d pmin, Vector3d pmax)
IsRenderableupdateBounds in interface IsRenderableupdateBounds in class Framepmin - minimum pointpmax - maximum pointpublic PolygonalMesh getSurfaceMesh()
HasSurfaceMeshnull if no mesh exists. If multiple surface
meshes exist, this should be first one in the array returned
by HasSurfaceMesh.getSurfaceMeshes().getSurfaceMesh in interface HasSurfaceMeshpublic int numSurfaceMeshes()
HasSurfaceMeshHasSurfaceMesh.getSurfaceMesh()
returns null, then this method should return 0.numSurfaceMeshes in interface HasSurfaceMeshpublic PolygonalMesh[] getSurfaceMeshes()
HasSurfaceMeshHasSurfaceMesh.getSurfaceMesh() returns null, then a
zero-length array should be returned.getSurfaceMeshes in interface HasSurfaceMeshpublic FrameMarker createMarker(Point3d pnt, boolean project)
pnt - location to add markerproject - project to image surfacepublic Marker createMarker(Line ray)
IsMarkablecreateMarker in interface IsMarkableray - ray to intersect withpublic RenderableComponentList<? extends FrameMarker> getMarkers()
public java.util.Iterator<? extends HierarchyNode> getChildren()
getChildren in interface HierarchyNodegetChildren in class ModelComponentBasepublic java.util.Iterator<ModelComponent> iterator()
public boolean hasChildren()
hasChildren in interface HierarchyNodehasChildren in class ModelComponentBasepublic boolean hasState()
DynamicComponentBasehasState in interface HasNumericStatehasState in interface ModelComponenthasState in class DynamicComponentBasetrue if this component has statepublic ModelComponent get(java.lang.String nameOrNumber)
get in interface CompositeComponentnameOrNumber - name or number of the subcomponentpublic ModelComponent get(int idx)
get in interface CompositeComponentget in interface IndexedComponentListidx - index of the subcomponentpublic ModelComponent getByNumber(int num)
getByNumber in interface CompositeComponentnum - number of the subcomponentpublic int numComponents()
numComponents in interface CompositeComponentnumComponents in interface IndexedComponentListpublic int indexOf(ModelComponent comp)
indexOf in interface CompositeComponentcomp - component whose index is requestedpublic ModelComponent findComponent(java.lang.String path)
findComponent in interface CompositeComponentpath - path leading to the subcomponentpublic int getNumberLimit()
getNumberLimit in interface CompositeComponentpublic CompositeComponent.NavpanelDisplay getNavpanelDisplay()
getNavpanelDisplay in interface CompositeComponentpublic void setDisplayMode(CompositeComponent.NavpanelDisplay mode)
NORMAL.mode - new display modepublic void componentChanged(ComponentChangeEvent e)
This method should propagate the notification up the component hierarchy
by calling notifyParentOfChange.
componentChanged in interface ComponentChangeListenercomponentChanged in interface CompositeComponente - optional argument giving specific information about the changepublic void updateNameMap(java.lang.String newName,
java.lang.String oldName,
ModelComponent comp)
updateNameMap in interface CompositeComponentpublic boolean hierarchyContainsReferences()
In particular, this means that one does not need to search outside the hierarchy when looking for dependencies.
hierarchyContainsReferences in interface CompositeComponentpublic void scan(ReaderTokenizer rtok, java.lang.Object ref) throws java.io.IOException
ModelComponentBasewrite.scan in interface ModelComponentscan in interface Scannablescan in class ModelComponentBasertok - Tokenizer from which to scan the elementref - optional reference object which can be used for resolving references to
other objectsjava.io.IOException - if an I/O or formatting error occuredpublic void postscan(java.util.Deque<ScanToken> tokens, CompositeComponent ancestor) throws java.io.IOException
PostScannablescan() 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.postscan in interface PostScannablepostscan in class ModelComponentBasetokens - token information that was stored during
scan().ancestor - ancestor component with respect to which
reference component paths are defined.java.io.IOException - if an error is encountered (such as a reference to a
non-existent component)public TexturePlaneBase copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap)
CopyableComponentCOPY_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.copy in interface CopyableComponentcopy in class Frameflags - flags to control the copyingcopyMap - map to possible existing instances of referenced
components