artisynth.core.mechmodels

Class ParticleConstraintBase

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.mechmodels.ConstrainerBase

artisynth.core.mechmodels.ParticleConstraintBase

All Implemented Interfaces:

Constrainer, HasAuxState, ModelComponent, RenderableComponent, ScalableUnits, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

Direct Known Subclasses:

ParticleLineConstraint, ParticleMeshConstraint, ParticlePlaneConstraint

public abstract class ParticleConstraintBase
extends ConstrainerBase
implements ScalableUnits

NOTE: This class is still under construction. scaleDistance(), transformGeometry(), and scan() and write() are unlikely to work properly.

Nested Class Summary

Nested classes/interfaces inherited from interface artisynth.core.mechmodels.HasAuxState

HasAuxState.StateContext

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.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
ParticleConstraintBase()

Method Summary

Modifier and Type	Method and Description
int	addBilateralConstraints(SparseBlockMatrix GT, VectorNd dg, int numb)
void	addParticle(Particle p)
void	addParticles(java.util.Collection<? extends Particle> parts)
int	addUnilateralConstraints(SparseBlockMatrix NT, VectorNd dg, int numu)
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
void	getAuxState(DataBuffer data) Saves state information for this component by adding data to the supplied DataBuffer.
int	getBilateralImpulses(VectorNd lam, int idx)
int	getBilateralInfo(MechSystem.ConstraintInfo[] ginfo, int idx)
void	getBilateralSizes(VectorNi sizes)
double	getCompliance()
void	getConstrainedComponents(java.util.List<DynamicComponent> list)
double	getDamping()
void	getInitialAuxState(DataBuffer newData, DataBuffer oldData) Saves initial state information data for this component by adding data to the supplied data buffer.
Particle	getParticle(int idx)
double	getPenetrationTol()
void	getSoftReferences(java.util.List<ModelComponent> refs) Appends all soft references for this component to a list.
int	getUnilateralImpulses(VectorNd the, int idx)
int	getUnilateralInfo(MechSystem.ConstraintInfo[] ninfo, int idx)
void	getUnilateralSizes(VectorNi sizes)
boolean	isEngaged(int idx)
boolean	isUnilateral()
int	numParticles()
boolean	removeParticle(Particle p)
void	setAuxState(DataBuffer data) Restores the state for this component by reading from the supplied data buffer, starting at the current buffer offsets.
int	setBilateralImpulses(VectorNd lam, double h, int idx)
void	setCompliance(double c)
void	setDamping(double d)
void	setPenetrationTol(double tol)
void	setUnilateral(boolean unilateral)
int	setUnilateralImpulses(VectorNd the, double h, int idx)
void	skipAuxState(DataBuffer data) Skips over the state information for this component contained in the supplied data buffer, starting at the current buffer offsets.
void	updateReferences(boolean undo, java.util.Deque<java.lang.Object> undoInfo) May be called by the system if any of the soft references for this component are removed from the the component hierarchy.
void	zeroImpulses()

Methods inherited from class artisynth.core.mechmodels.ConstrainerBase

addFrictionConstraints, advanceAuxState, hasState, maxFrictionConstraintSets, updateConstraints

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

copy, createRenderProps, getRenderHints, getRenderProps, getSelection, isSelectable, numSelectionQueriesNeeded, prerender, render, setRenderProps, updateBounds, 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, hasChildren, isConnectedToHierarchy, isFixed, isMarked, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setSelected, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface artisynth.core.util.ScalableUnits

scaleDistance, scaleMass

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, isFixed, isMarked, isSelected, notifyParentOfChange, postscan, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected

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

ParticleConstraintBase

public ParticleConstraintBase()

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 ModelComponentBase

Returns:

static information for all exported properties

getDamping

public double getDamping()

setDamping

public void setDamping(double d)

getCompliance

public double getCompliance()

setCompliance

public void setCompliance(double c)

getPenetrationTol

public double getPenetrationTol()

setPenetrationTol

public void setPenetrationTol(double tol)

isUnilateral

public boolean isUnilateral()

setUnilateral

public void setUnilateral(boolean unilateral)

addParticle

public void addParticle(Particle p)

addParticles

public void addParticles(java.util.Collection<? extends Particle> parts)

getParticle

public Particle getParticle(int idx)

numParticles

public int numParticles()

removeParticle

public boolean removeParticle(Particle p)

getBilateralSizes

public void getBilateralSizes(VectorNi sizes)

Specified by:

getBilateralSizes in interface Constrainer

Specified by:

getBilateralSizes in class ConstrainerBase

addBilateralConstraints

public int addBilateralConstraints(SparseBlockMatrix GT,
                                   VectorNd dg,
                                   int numb)

Specified by:

addBilateralConstraints in interface Constrainer

Specified by:

addBilateralConstraints in class ConstrainerBase

getBilateralInfo

public int getBilateralInfo(MechSystem.ConstraintInfo[] ginfo,
                            int idx)

Specified by:

getBilateralInfo in interface Constrainer

Specified by:

getBilateralInfo in class ConstrainerBase

setBilateralImpulses

public int setBilateralImpulses(VectorNd lam,
                                double h,
                                int idx)

Specified by:

setBilateralImpulses in interface Constrainer

Specified by:

setBilateralImpulses in class ConstrainerBase

getBilateralImpulses

public int getBilateralImpulses(VectorNd lam,
                                int idx)

Specified by:

getBilateralImpulses in interface Constrainer

Specified by:

getBilateralImpulses in class ConstrainerBase

getUnilateralSizes

public void getUnilateralSizes(VectorNi sizes)

Specified by:

getUnilateralSizes in interface Constrainer

Overrides:

getUnilateralSizes in class ConstrainerBase

addUnilateralConstraints

public int addUnilateralConstraints(SparseBlockMatrix NT,
                                    VectorNd dg,
                                    int numu)

Specified by:

addUnilateralConstraints in interface Constrainer

Overrides:

addUnilateralConstraints in class ConstrainerBase

getUnilateralInfo

public int getUnilateralInfo(MechSystem.ConstraintInfo[] ninfo,
                             int idx)

Specified by:

getUnilateralInfo in interface Constrainer

Overrides:

getUnilateralInfo in class ConstrainerBase

setUnilateralImpulses

public int setUnilateralImpulses(VectorNd the,
                                 double h,
                                 int idx)

Specified by:

setUnilateralImpulses in interface Constrainer

Overrides:

setUnilateralImpulses in class ConstrainerBase

getUnilateralImpulses

public int getUnilateralImpulses(VectorNd the,
                                 int idx)

Specified by:

getUnilateralImpulses in interface Constrainer

Overrides:

getUnilateralImpulses in class ConstrainerBase

zeroImpulses

public void zeroImpulses()

Specified by:

zeroImpulses in interface Constrainer

Specified by:

zeroImpulses in class ConstrainerBase

isEngaged

public boolean isEngaged(int idx)

getConstrainedComponents

public void getConstrainedComponents(java.util.List<DynamicComponent> list)

Specified by:

getConstrainedComponents in interface Constrainer

Specified by:

getConstrainedComponents in class ConstrainerBase

getSoftReferences

public void getSoftReferences(java.util.List<ModelComponent> refs)

Description copied from class: ModelComponentBase

Appends all soft references for this component to a list. References are other components, outside of this component's immediate ancestry, on which this component depends. For example, an ExcitationComponent may refer to one or more other ExcitationComponents to act as excitation sources. A soft reference is one which can be removed from the referring component. In particular, if any soft references for a component are deleted, then that component's updateReferences() method will be called to update its internal reference information.

Specified by:

getSoftReferences in interface ModelComponent

Overrides:

getSoftReferences in class ModelComponentBase

Parameters:

refs - list to which soft references are appended

updateReferences

public void updateReferences(boolean undo,
                             java.util.Deque<java.lang.Object> undoInfo)

Description copied from class: ModelComponentBase

May be called by the system if any of the soft references for this component are removed from the the component hierarchy. If called with undo equal to false, this component should then examine its soft references and use ComponentUtils.isConnected() to determine which of them have been disconnected from the hierarchy. Disconnected references should be removed, and sufficient information should be appended to undoInfo to allow this update to be undone if this method is called later with undo equal to true. When undoing an update, the undo information should be removed from the front of undoInfo.

Specified by:

updateReferences in interface ModelComponent

Overrides:

updateReferences in class ModelComponentBase

Parameters:

undo - if true, indicates that the most recent reference update should be undone, using the supplied undo information.

undoInfo - if undo is false, should be used to store information allowing the reference update to be undone. Otherwise, if undo is true, then this supplied information to undo the most recent update.

skipAuxState

public void skipAuxState(DataBuffer data)

Skips over the state information for this component contained in the supplied data buffer, starting at the current buffer offsets. Essentially this a dummy read; the buffer offsets should be advanced over the state information, but that information should not actually be stored in the component.

Specified by:

skipAuxState in interface HasAuxState

Overrides:

skipAuxState in class ConstrainerBase

Parameters:

data - buffer containing the state information

getAuxState

public void getAuxState(DataBuffer data)

Description copied from interface: HasAuxState

Saves state information for this component by adding data to the supplied DataBuffer. Existing data in the buffer should not be disturbed.

Specified by:

getAuxState in interface HasAuxState

Overrides:

getAuxState in class ConstrainerBase

Parameters:

data - buffer for storing the state values.

getInitialAuxState

public void getInitialAuxState(DataBuffer newData,
                               DataBuffer oldData)

Description copied from interface: HasAuxState

Saves initial state information data for this component by adding data to the supplied data buffer. Existing data in the buffer should not be disturbed.

If oldData is non-null, then this contains previously stored initial state information (starting at its current buffer offsets), which should be stored into newData in place of the current component state data. This may only be partially possible if the component's state structure has changed since oldData was written.

Specified by:

getInitialAuxState in interface HasAuxState

Overrides:

getInitialAuxState in class ConstrainerBase

Parameters:

newData - buffer for storing the state values.

oldData - if non-null, contains old state information that should be written into newData in place of the current state information.

setAuxState

public void setAuxState(DataBuffer data)

Description copied from interface: HasAuxState

Restores the state for this component by reading from the supplied data buffer, starting at the current buffer offsets.

Specified by:

setAuxState in interface HasAuxState

Overrides:

setAuxState in class ConstrainerBase

Parameters:

data - buffer containing the state information