artisynth.core.mechmodels

Class SkinMeshBase

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.mechmodels.MeshComponent

artisynth.core.mechmodels.SkinMeshBase

All Implemented Interfaces:

HasSlaveObjects, HasSurfaceMesh, ComponentChangeListener, CompositeComponent, IndexedComponentList, ModelComponent, RenderableComponent, TransformableGeometry, ScalableUnits, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

Direct Known Subclasses:

FemMeshBase, SkinMeshBody

public abstract class SkinMeshBase
extends MeshComponent
implements HasSlaveObjects, CompositeComponent, HasSurfaceMesh

Base class for a SkinMeshBody, which is a type of mesh component in which each vertex is attached to one or more underlying dynamic master components using a PointAttachment.

Nested Class Summary

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

CompositeComponent.NavpanelDisplay

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

ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps

Fields inherited from class artisynth.core.mechmodels.MeshComponent

DEFAULT_COLOR_INTERPOLATION, DEFAULT_VERTEX_COLOR_MIXING

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

Constructor Summary

Constructors

Constructor and Description
SkinMeshBase()
SkinMeshBase(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	componentChanged(ComponentChangeEvent e) Notifies this composite component that a change has occured within one or more of its descendants.
SkinMeshBase	copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap)
ModelComponent	findComponent(java.lang.String path) Recursively searches for a sub-component of this ModelComponent, identified by a path of component names.
ModelComponent	get(int idx) Returns a specific sub-component of this ModelComponent, identified by index.
ModelComponent	get(java.lang.String nameOrNumber) Returns a specific sub-component of this ModelComponent, identified by name or string representation of the sub-component's number
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
abstract PointAttachment	getAttachment(int idx)
ModelComponent	getByNumber(int num) Returns a specific sub-component of this ModelComponent, identified by number.
CompositeComponent.NavpanelDisplay	getNavpanelDisplay() Returns the DisplayMode for this component.
ModelComponent.NavpanelVisibility	getNavpanelVisibility()
int	getNumberLimit() Returns the current upper limit for numbers among all sub-components 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	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 sub-component, or -1 if that the component is not present.
abstract int	numAttachments()
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	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	setNavpanelDisplay(CompositeComponent.NavpanelDisplay mode) Sets the display mode for 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	updateNameMap(java.lang.String newName, java.lang.String oldName, ModelComponent comp)
void	updateSlavePos() Updates the mesh vertices to reflect the current position of the attached Frames, FemModels, and points.
void	updateSlaveVel() Called when the system's dynamic velocity state changes, to update the velocity state of the slave objects.

Methods inherited from class artisynth.core.mechmodels.MeshComponent

addTransformableDependencies, createRenderProps, createSurfaceMeshArray, getColorInterpolation, getFileTransform, getMesh, getMeshToWorld, getSurfaceMeshes, getVertex, getVertexColorMixing, isFileTransformRigid, isMeshModfied, numSurfaceMeshes, numVertices, prerender, render, render, scaleMass, setColorInterpolation, setDefaultValues, setMesh, setMesh, setMesh, setMeshToWorld, setVertexColorMixing, transformGeometry, updateBounds, updatePosition

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

getRenderHints, getRenderProps, getSelection, isSelectable, numSelectionQueriesNeeded, setRenderProps, updateRenderProps

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, createTempFlag, disconnectFromHierarchy, getChildren, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasChildren, hasState, isConnectedToHierarchy, isFixed, isMarked, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setSelected, 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.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNumber, getParent, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, 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

myProps

public static PropertyList myProps

Constructor Detail

SkinMeshBase

public SkinMeshBase()

SkinMeshBase

public SkinMeshBase(java.lang.String name)

Method Detail

numAttachments

public abstract int numAttachments()

getAttachment

public abstract PointAttachment getAttachment(int idx)

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 MeshComponent

Returns:

static information for all exported properties

get

public ModelComponent get(java.lang.String nameOrNumber)

Returns a specific sub-component of this ModelComponent, identified by name or string representation of the sub-component's number

Specified by:

get in interface CompositeComponent

Parameters:

nameOrNumber - name or number of the sub-component

Returns:

named sub-component, or null if the component does not exist.

get

public ModelComponent get(int idx)

Returns a specific sub-component of this ModelComponent, identified by index.

Specified by:

get in interface CompositeComponent

Specified by:

get in interface IndexedComponentList

Parameters:

idx - index of the sub-component

Returns:

indexed sub-component, or null if the component does not exist.

getByNumber

public ModelComponent getByNumber(int num)

Returns a specific sub-component of this ModelComponent, identified by number.

Specified by:

getByNumber in interface CompositeComponent

Parameters:

num - number of the sub-component

Returns:

specified sub-component, or null if the component does not exist.

numComponents

public int numComponents()

Returns the number of components in this CompositeComponent.

Specified by:

numComponents in interface CompositeComponent

Specified by:

numComponents in interface IndexedComponentList

Returns:

number of sub-components

indexOf

public int indexOf(ModelComponent comp)

Returns the index of a specified sub-component, or -1 if that the component is not present.

Specified by:

indexOf in interface CompositeComponent

Parameters:

comp - component whose index is requested

Returns:

indexed sub-component

findComponent

public ModelComponent findComponent(java.lang.String path)

Recursively searches for a sub-component of this ModelComponent, identified by a path of component names.

Specified by:

findComponent in interface CompositeComponent

Parameters:

path - path leading to the sub-component

Returns:

named sub-component, or null if the component does not exist.

getNumberLimit

public int getNumberLimit()

Returns the current upper limit for numbers among all sub-components in this composite. This is one greater than the maximum sub-component number currently assigned. A value of 0 means that there are no sub-components. This method is useful for creating and sizing arrays whose contents are indexed by component numbers.

Specified by:

getNumberLimit in interface CompositeComponent

Returns:

upper limit for numbers among all sub-components

getNavpanelDisplay

public CompositeComponent.NavpanelDisplay getNavpanelDisplay()

Returns the DisplayMode for this component. This specifies how the component should be displayed in a navigation panel.

Specified by:

getNavpanelDisplay in interface CompositeComponent

Returns:

display mode for this component

setNavpanelDisplay

public void setNavpanelDisplay(CompositeComponent.NavpanelDisplay mode)

Sets the display mode for this component. This controls how the component is displayed in a navigation panel. The default setting is NORMAL.

Parameters:

mode - new display mode

setDisplayMode

public void setDisplayMode(CompositeComponent.NavpanelDisplay mode)

Sets the display mode for this component. This controls how the component is displayed in a navigation panel. The default setting is NORMAL.

Parameters:

mode - new display mode

getNavpanelVisibility

public ModelComponent.NavpanelVisibility getNavpanelVisibility()

Specified by:

getNavpanelVisibility in interface ModelComponent

Overrides:

getNavpanelVisibility in class ModelComponentBase

componentChanged

public void componentChanged(ComponentChangeEvent e)

Notifies this composite component that a change has occured within one or more of its descendants. When this occurs, the composite may need to invalidate cached information that depends on the descendants.

This method should propagate the notification up the component hierarchy by calling notifyParentOfChange.

Specified by:

componentChanged in interface ComponentChangeListener

Specified by:

componentChanged in interface CompositeComponent

Parameters:

e - optional argument giving specific information about the change

updateNameMap

public void updateNameMap(java.lang.String newName,
                          java.lang.String oldName,
                          ModelComponent comp)

Specified by:

updateNameMap in interface CompositeComponent

hierarchyContainsReferences

public boolean hierarchyContainsReferences()

Returns true if the component hierarchy formed by this component and its descendents is closed with respect to references. In other words, all components referenced by components within the hierarchy are themselves components within the hierarchy.

In particular, this means that one does not need to search outside the hierarchy when looking for dependencies.

Specified by:

hierarchyContainsReferences in interface CompositeComponent

Returns:

true if this component's hierarchy is closed with respect to references.

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 ModelComponentBase

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: ModelComponent

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 ModelComponent

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)

updateSlavePos

public void updateSlavePos()

Updates the mesh vertices to reflect the current position of the attached Frames, FemModels, and points.

Specified by:

updateSlavePos in interface HasSlaveObjects

Overrides:

updateSlavePos in class MeshComponent

updateSlaveVel

public void updateSlaveVel()

Description copied from interface: HasSlaveObjects

Called when the system's dynamic velocity state changes, to update the velocity state of the slave objects.

Specified by:

updateSlaveVel in interface HasSlaveObjects

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 MeshComponent

Parameters:

s - scaling factor

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 MeshComponent

Parameters:

gtr - transformer implementing the transform

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

flags - specifies conditions associated with the transformation

copy

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

Overrides:

copy in class MeshComponent

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