artisynth.core.mechmodels

Class MeshComponent

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.mechmodels.MeshComponent

All Implemented Interfaces:

ModelComponent, PostScannable, RenderableComponent, TransformableGeometry, ScalableUnits, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

Direct Known Subclasses:

DynamicMeshComponent, FixedMeshBody

public class MeshComponent
extends RenderableComponentBase
implements TransformableGeometry, ScalableUnits

Contains information about a mesh, including the mesh itself, and it's possible file name and transformation with respect to the original file definition.

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 Renderer.ColorInterpolation	DEFAULT_COLOR_INTERPOLATION
static boolean	DEFAULT_SELECTABLE
static Renderer.ColorMixing	DEFAULT_VERTEX_COLOR_MIXING
static PropertyList	myProps

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
MeshComponent()
MeshComponent(MeshBase mesh, java.lang.String fileName, AffineTransform3dBase X)
MeshComponent(java.lang.String name)

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.
MeshComponent	copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap)
static PolygonalMesh[]	createSurfaceMeshArray(PolygonalMesh mesh)
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
Renderer.ColorInterpolation	getColorInterpolation()
java.lang.String	getFileName() Returns the file name, if any, associated with this mesh.
AffineTransform3d	getFileTransform() Returns the file transform, if any, associated with this mesh.
MeshBase	getMesh()
RigidTransform3d	getMeshToWorld()
static PolygonalMesh[]	getSurfaceMeshes(MeshComponentList<?> list)
Vertex3d	getVertex(int idx)
Renderer.ColorMixing	getVertexColorMixing()
boolean	isFileTransformRigid()
boolean	isMeshModified()
boolean	isMeshPolygonal()
boolean	isMeshTriangular()
boolean	isSelectable() Returns true if this object is in fact selectable.
static int	numSurfaceMeshes(MeshComponentList<?> list)
int	numVertices()
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	prerenderMesh()
void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	render(Renderer renderer, RenderProps props, int flags)
void	scaleDistance(double s) Scales all distance coordinates.
void	scaleMass(double s) Scales all mass units.
void	setColorInterpolation(Renderer.ColorInterpolation interp)
void	setFileName(java.lang.String name) Sets a file name for this mesh, or clears it if name is null.
void	setFileTransform(AffineTransform3dBase X) Sets a file transform for this mesh, or clears it if name is null.
void	setMesh(MeshBase mesh)
void	setMesh(MeshBase mesh, java.lang.String fileName)
void	setMesh(MeshBase mesh, java.lang.String fileName, AffineTransform3dBase X)
void	setMeshToWorld(RigidTransform3d TMW)
void	setSelectable(boolean enable)
void	setVertexColorMixing(Renderer.ColorMixing cmix)
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	updatePosition(int flags)
void	updateSlavePos()

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

createRenderProps, defaultRenderPropsAreNull, getRenderHints, getRenderProps, getSelection, isVisible, numSelectionQueriesNeeded, setRenderProps, setVisible, updateRenderProps

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, createTempFlag, disconnectFromHierarchy, getChildren, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasChildren, hasState, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, 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

transformPriority

Methods inherited from interface artisynth.core.modelbase.ModelComponent

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

Field Detail

DEFAULT_SELECTABLE

public static boolean DEFAULT_SELECTABLE

myProps

public static PropertyList myProps

DEFAULT_COLOR_INTERPOLATION

public static final Renderer.ColorInterpolation DEFAULT_COLOR_INTERPOLATION

DEFAULT_VERTEX_COLOR_MIXING

public static final Renderer.ColorMixing DEFAULT_VERTEX_COLOR_MIXING

Constructor Detail

MeshComponent

public MeshComponent(java.lang.String name)

MeshComponent

public MeshComponent()

MeshComponent

public MeshComponent(MeshBase mesh,
                     java.lang.String fileName,
                     AffineTransform3dBase X)

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 RenderableComponentBase

Returns:

static information for all exported properties

setMesh

public void setMesh(MeshBase mesh,
                    java.lang.String fileName,
                    AffineTransform3dBase X)

setMesh

public void setMesh(MeshBase mesh,
                    java.lang.String fileName)

setMesh

public void setMesh(MeshBase mesh)

getColorInterpolation

public Renderer.ColorInterpolation getColorInterpolation()

setColorInterpolation

public void setColorInterpolation(Renderer.ColorInterpolation interp)

getVertexColorMixing

public Renderer.ColorMixing getVertexColorMixing()

setVertexColorMixing

public void setVertexColorMixing(Renderer.ColorMixing cmix)

getVertex

public Vertex3d getVertex(int idx)

numVertices

public int numVertices()

getMesh

public MeshBase getMesh()

getMeshToWorld

public RigidTransform3d getMeshToWorld()

setMeshToWorld

public void setMeshToWorld(RigidTransform3d TMW)

getFileName

public java.lang.String getFileName()

Returns the file name, if any, associated with this mesh. If the mesh does not have a file name, then when this component is written out (using its ModelComponentBase.write(java.io.PrintWriter, maspack.util.NumberFormat, java.lang.Object) method), the mesh itself is written out inline using an .obj format. Otherwise, if the mesh has a file name, then that is written out instead, so that when the component is read in (using its ModelComponentBase.scan(maspack.util.ReaderTokenizer, java.lang.Object) method), the mesh is read from the indicated file.

Returns:

file name for this mesh.

setFileName

public void setFileName(java.lang.String name)

Sets a file name for this mesh, or clears it if name is null. See getFileName() for a description of what the file name does.

Parameters:

name - file name for this mesh.

getFileTransform

public AffineTransform3d getFileTransform()

Returns the file transform, if any, associated with this mesh. If non-null, and if the mesh also has a file name (see getFileName()), then this specifies a rigid or affine transform that was used to modify the mesh after it was read in from the file. When this component is written out (using its ModelComponentBase.write(java.io.PrintWriter, maspack.util.NumberFormat, java.lang.Object) method), this transform is written out along with the file name, so that it can be applied by ModelComponentBase.scan(maspack.util.ReaderTokenizer, java.lang.Object) after reading the mesh from the file, thus ensuring that the mesh is properly reconstructed.

The file transform has no relevance if the mesh does not have a file name.

Returns:

file transform for this mesh.

setFileTransform

public void setFileTransform(AffineTransform3dBase X)

Sets a file transform for this mesh, or clears it if name is null. See getFileTransform() for a description of what the file transform does.

Parameters:

X - file transform for this mesh.

isFileTransformRigid

public boolean isFileTransformRigid()

isMeshModified

public boolean isMeshModified()

isMeshTriangular

public boolean isMeshTriangular()

isMeshPolygonal

public boolean isMeshPolygonal()

isSelectable

public boolean isSelectable()

Description copied from class: RenderableComponentBase

Returns true if this object is in fact selectable.

Specified by:

isSelectable in interface IsSelectable

Overrides:

isSelectable in class RenderableComponentBase

Returns:

true if this object is selectable

setSelectable

public void setSelectable(boolean enable)

prerenderMesh

public void prerenderMesh()

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 RenderableComponentBase

Parameters:

list - list of objects to be rendered

render

public void render(Renderer renderer,
                   RenderProps props,
                   int flags)

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

Specified by:

render in class RenderableComponentBase

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 RenderableComponentBase

Parameters:

pmin - minimum point

pmax - maximum point

updatePosition

public void updatePosition(int flags)

scaleDistance

public void scaleDistance(double s)

Description copied from interface: ScalableUnits

Scales all distance coordinates.

Specified by:

scaleDistance in interface ScalableUnits

Parameters:

s - scaling factor

scaleMass

public void scaleMass(double s)

Description copied from interface: ScalableUnits

Scales all mass units.

Specified by:

scaleMass in interface ScalableUnits

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

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

updateSlavePos

public void updateSlavePos()

createSurfaceMeshArray

public static PolygonalMesh[] createSurfaceMeshArray(PolygonalMesh mesh)

numSurfaceMeshes

public static int numSurfaceMeshes(MeshComponentList<?> list)

getSurfaceMeshes

public static PolygonalMesh[] getSurfaceMeshes(MeshComponentList<?> list)

copy

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

Overrides:

copy in class RenderableComponentBase