CoordinateLimitForce (Artisynth API documentation)

java.lang.Object
- artisynth.core.opensim.components.OpenSimObject
- - artisynth.core.opensim.components.VisibleBase
  - - artisynth.core.opensim.components.HasVisibleObject
    - - artisynth.core.opensim.components.ForceBase
      - artisynth.core.opensim.components.CoordinateLimitForce

All Implemented Interfaces:

ModelComponentGenerator<ModelComponent>, java.lang.Cloneable, Clonable
```
public class CoordinateLimitForce
extends ForceBase
```

Nested Class Summary
- Nested classes/interfaces inherited from class artisynth.core.opensim.components.VisibleBase
  VisibleBase.DisplayPreference

Constructor Summary

Constructors
Constructor and Description

CoordinateLimitForce()

Constructors
Constructor and Description
`CoordinateLimitForce()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CoordinateLimitForce`	`clone()`
`JointLimitForce`	`createComponent(java.io.File geometryPath, ModelComponentMap componentMap)` Creates and returns a model component, using the provided component map to look up other dependent objects.
`java.lang.String`	`getCoordinate()`
`double`	`getDamping()`
`double`	`getLowerLimit()`
`double`	`getLowerStiffness()`
`double`	`getTransition()`
`double`	`getUpperLimit()`
`double`	`getUpperStiffness()`
`void`	`setCoordinate(java.lang.String coord)`
`void`	`setDamping(double d)`
`void`	`setLowerLimit(double lim)`
`void`	`setLowerStiffness(double k)`
`void`	`setTransition(double d)`
`void`	`setUpperLimit(double lim)`
`void`	`setUpperStiffness(double k)`

Methods inherited from class artisynth.core.opensim.components.ForceBase
getAppliesForce, isDisabled, setAppliesForce, setDisabled

Methods inherited from class artisynth.core.opensim.components.HasVisibleObject
createRenderProps, getVisibleObject, setVisibleObject

Methods inherited from class artisynth.core.opensim.components.VisibleBase
getColor, getDisplayPreference, getOpacity, setColor, setDisplayPreference, setOpacity

Methods inherited from class artisynth.core.opensim.components.OpenSimObject
getName, getParent, getPath, setName, setParent

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CoordinateLimitForce
```
public CoordinateLimitForce()
```
- Method Detail
  - setUpperLimit
```
public void setUpperLimit(double lim)
```
  - getUpperLimit
```
public double getUpperLimit()
```
  - setUpperStiffness
```
public void setUpperStiffness(double k)
```
  - getUpperStiffness
```
public double getUpperStiffness()
```
  - setLowerLimit
```
public void setLowerLimit(double lim)
```
  - getLowerLimit
```
public double getLowerLimit()
```
  - setLowerStiffness
```
public void setLowerStiffness(double k)
```
  - getLowerStiffness
```
public double getLowerStiffness()
```
  - setDamping
```
public void setDamping(double d)
```
  - getDamping
```
public double getDamping()
```
  - setTransition
```
public void setTransition(double d)
```
  - getTransition
```
public double getTransition()
```
  - getCoordinate
```
public java.lang.String getCoordinate()
```
  - setCoordinate
```
public void setCoordinate(java.lang.String coord)
```
  - createComponent
```
public JointLimitForce createComponent(java.io.File geometryPath,
                                       ModelComponentMap componentMap)
```
    Description copied from interface: ModelComponentGenerator
    
    Creates and returns a model component, using the provided component map to look up other dependent objects. The newly created component should also be added to the componentMap.
    
    Specified by:
    
    createComponent in interface ModelComponentGenerator<ModelComponent>
    
    Specified by:
    
    createComponent in class ForceBase
    
    Parameters:
    
    geometryPath - path to search for geometry files
    
    componentMap - map for looking up other objects
    
    Returns:
    
    created component
  - clone
```
public CoordinateLimitForce clone()
```
    Specified by:
    
    clone in interface Clonable
    
    Overrides:
    
    clone in class ForceBase

Class CoordinateLimitForce

Nested Class Summary

Nested classes/interfaces inherited from class artisynth.core.opensim.components.VisibleBase

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.opensim.components.ForceBase

Methods inherited from class artisynth.core.opensim.components.HasVisibleObject

Methods inherited from class artisynth.core.opensim.components.VisibleBase

Methods inherited from class artisynth.core.opensim.components.OpenSimObject

Methods inherited from class java.lang.Object

Constructor Detail

CoordinateLimitForce

Method Detail

setUpperLimit

getUpperLimit

setUpperStiffness

getUpperStiffness

setLowerLimit

getLowerLimit

setLowerStiffness

getLowerStiffness

setDamping

getDamping

setTransition

getTransition

getCoordinate

setCoordinate

createComponent

clone