artisynth.core.mechmodels

Class PlanarConnector

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.mechmodels.BodyConnector

artisynth.core.mechmodels.PlanarConnector

All Implemented Interfaces:

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

public class PlanarConnector
extends BodyConnector
implements CopyableComponent

Auxiliary class used to solve constrained rigid body problems.

Nested Class Summary

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

ModelComponent.NavpanelVisibility

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

HasAuxState.StateContext

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 artisynth.core.modelbase.CopyableComponent

COPY_REFERENCES

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
PlanarConnector()
PlanarConnector(RigidBody bodyA, Vector3d pCA, RigidBody bodyB, RigidTransform3d XPB)
PlanarConnector(RigidBody bodyA, Vector3d pCA, RigidTransform3d XPW)

Method Summary

Modifier and Type	Method and Description
ModelComponent	copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap) Create a copy of this component.
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
RigidBodyConstraint	getConstraint()
Vector3d	getNormal()
double	getPlanarActivation()
double	getPlaneNormal(Vector3d nrm) Gets the current plane normal, in world coordinates.
double	getPlaneSize()
boolean	isUnilateral()
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	set(RigidBody bodyA, Point3d pCA, Vector3d worldPlaneNormal)
void	set(RigidBody bodyA, Vector3d pCA, RigidBody bodyB, RigidTransform3d XPB) Sets this PlanarConnectorX to connect two rigid bodies.
void	set(RigidBody bodyA, Vector3d pCA, RigidTransform3d XPW) Sets this PlanarConnectorX to connect a rigid body with the world frame.
void	setDefaultValues() Sets the attributes of this component to their default values.
void	setPlaneSize(double len)
void	setUnilateral(boolean unilateral)
void	updateBounds(Vector3d pmin, Vector3d pmax) Update the minimum and maximum points for this object.

Methods inherited from class artisynth.core.mechmodels.BodyConnector

addBilateralConstraints, addFrictionConstraints, addMasterBlocks, addTransformableDependencies, addUnilateralConstraints, advanceAuxState, connectToHierarchy, disconnectFromHierarchy, findAttachedBodies, getActivation, getAuxState, getBilateralConstraints, getBilateralForceInA, getBilateralForceInA, getBilateralImpulses, getBilateralInfo, getBilateralSizes, getBodyA, getBodyB, getBreakAccel, getBreakSpeed, getCompliance, getConstrainedComponents, getContactDistance, getCopyReferences, getCurrentTCW, getCurrentTCW, getCurrentTDW, getCurrentTDW, getCurrentTXW, getDamping, getHardReferences, getInitialAuxState, getLinearCompliance, getOtherBody, getPenetrationTol, getPenetrationTolMode, getPose, getRotaryCompliance, getUnilateralConstraints, getUnilateralForceInA, getUnilateralForceInA, getUnilateralImpulses, getUnilateralInfo, getUnilateralSizes, hasState, hasTranslation, hasUnilateralConstraints, isActive, isDuplicatable, isEnabled, maxFrictionConstraintSets, numBilateralConstraints, numBodies, numUnilateralConstraints, printConstraintInfo, scaleMass, setAuxState, setBilateralImpulses, setBodies, setBodies, setBodies, setBodies, setBreakAccel, setBreakSpeed, setCompliance, setContactDistance, setCurrentTCW, setCurrentTDW, setDamping, setEnabled, setLinearCompliance, setPenetrationTol, setPenetrationTolMode, setRotaryCompliance, setUnilateralImpulses, skipAuxState, transformGeometry, transformGeometry, updateBodyStates, updateConstraints, updateForBodyPositionChange, updateUnilateralConstraints, zeroImpulses

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, createTempFlag, getChildren, getGrandParent, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasChildren, isConnectedToHierarchy, isFixed, isMarked, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, 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.CopyableComponent

getCopyReferences, isDuplicatable

Methods inherited from interface artisynth.core.modelbase.ModelComponent

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

PlanarConnector

public PlanarConnector()

PlanarConnector

public PlanarConnector(RigidBody bodyA,
                       Vector3d pCA,
                       RigidBody bodyB,
                       RigidTransform3d XPB)

PlanarConnector

public PlanarConnector(RigidBody bodyA,
                       Vector3d pCA,
                       RigidTransform3d XPW)

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 BodyConnector

Returns:

static information for all exported properties

getNormal

public Vector3d getNormal()

setDefaultValues

public void setDefaultValues()

Description copied from class: ModelComponentBase

Sets the attributes of this component to their default values.

getPlaneSize

public double getPlaneSize()

setPlaneSize

public void setPlaneSize(double len)

getPlaneNormal

public double getPlaneNormal(Vector3d nrm)

Gets the current plane normal, in world coordinates. Also return the plane offset.

Parameters:

nrm - returns the plane normal

getConstraint

public RigidBodyConstraint getConstraint()

set

public void set(RigidBody bodyA,
                Point3d pCA,
                Vector3d worldPlaneNormal)

set

public void set(RigidBody bodyA,
                Vector3d pCA,
                RigidBody bodyB,
                RigidTransform3d XPB)

Sets this PlanarConnectorX to connect two rigid bodies. The first body (A) is the one in which the contact point is fixed, while the second body (B) is the one in which the plane is fixed.

Parameters:

bodyA - first rigid body

pCA - location of contact point relative to body A

bodyB - second rigid body

XPB - plane coordinate frame with respect to body B. The plane normal is given by the z axis of this frame, and the plane's origin is given by XPB.p

set

public void set(RigidBody bodyA,
                Vector3d pCA,
                RigidTransform3d XPW)

Sets this PlanarConnectorX to connect a rigid body with the world frame. The contact point is fixed in the body frame, while the plane is fixed in the world frame.

Parameters:

bodyA - rigid body

pCA - location of contact point relative to body

XPW - plane coordinate frame with respect to the world. The plane normal is given by the z axis of this frame, and the plane's origin is given by XPB.p

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 BodyConnector

Parameters:

pmin - minimum point

pmax - maximum point

createRenderProps

public RenderProps createRenderProps()

Description copied from interface: HasRenderProps

Factory method to create render properties appropriate to this object.

Specified by:

createRenderProps in interface HasRenderProps

Overrides:

createRenderProps in class RenderableComponentBase

Returns:

new render properties for this object

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,
                   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.

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 BodyConnector

Parameters:

s - scaling factor

getPlanarActivation

public double getPlanarActivation()

isUnilateral

public boolean isUnilateral()

setUnilateral

public void setUnilateral(boolean unilateral)

copy

public ModelComponent 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 BodyConnector

Parameters:

flags - flags to control the copying

copyMap - map to possible existing instances of referenced components

Returns:

copy of this component