=============================== CoilSpring (hwx.inspire.motion) =============================== Creates a Coil Spring. Coil Springs are used to apply a translational spring-damper force along the line of sight between two parts. Coil Springs provide a linear resistance and/or damping between two objects. Changing any one of preload, installedLength, freeLength, or k will influence the other values: - Changing preload modifies freeLength. - Changing installedLength, k, or freeLength modifies the computed preload. Inherits: - :ref:`MotionConnector (hwx.inspire.motion)` ---------- Attributes ---------- +----------------------------+----------------------------+----------------------------+ | active_: Bool | c_: Double | clevisPinHoles_: Attribute | +----------------------------+----------------------------+----------------------------+ | clinear_: Bool | coilColor_: Color | coilDiameter_: Double | +----------------------------+----------------------------+----------------------------+ | coils_: Int | compute_: Enum | connectionRadius_: Double | +----------------------------+----------------------------+----------------------------+ | cspline_: Attribute | csplineMethod_: Enum | damperColor_: Color | +----------------------------+----------------------------+----------------------------+ | damperScale_: Double | diameter_: Double | direction_: Direction | +----------------------------+----------------------------+----------------------------+ | entity1_: Attribute | entity2_: Attribute | exponent_: Double | +----------------------------+----------------------------+----------------------------+ | flipAxis_: Bool | freeLength_: Double | installedLength_: Double | +----------------------------+----------------------------+----------------------------+ | k_: Double | klinear_: Bool | kspline_: Attribute | +----------------------------+----------------------------+----------------------------+ | ksplineMethod_: Enum | location1_: Location | location2_: Location | +----------------------------+----------------------------+----------------------------+ | locked_: Bool | max_damping_coeff_: Double | max_penetration_: Double | +----------------------------+----------------------------+----------------------------+ | mountColor_: Color | name_: Attribute | parallelMounts_: Bool | +----------------------------+----------------------------+----------------------------+ | parallelMountsJoint_: Enum | parts_: Attribute | preload_: Double | +----------------------------+----------------------------+----------------------------+ | reverseDirection_: Bool | rotation_: Double | springLimits_: Bool | +----------------------------+----------------------------+----------------------------+ | stiffness_: Double | type_: Enum | visible_: Bool | +----------------------------+----------------------------+----------------------------+ | wireDiameter_: Double | writePlantSignals_: Bool | | +----------------------------+----------------------------+----------------------------+ ---------- Properties ---------- +-------------+-------------+-------------+ | hasDamper_ | hasSpring_ | isGrounded_ | +-------------+-------------+-------------+ | lowerBound_ | upperBound_ | | +-------------+-------------+-------------+ ----------------- Attribute Details ----------------- .. _active: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ active : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns or sets the object activeness. Setting this on or off sets all children. Setting to True sets all the parents active too. .. _c: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ c : :ref:`Double ` (units="damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The damping value of the coil spring, dafaults to 1 N*s/m. .. _clevisPinHoles: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ clevisPinHoles : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Lists all the cylindrical features from a clevis pin part, that has 3 aligned holes and outside two holes are in the same part. .. _clinear: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ clinear : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Enables linear damping with the value specified for property c, else uses interpolation methods to get damping value. .. _coilColor: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ coilColor : :ref:`Color ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the color of the coils around the spring. .. _coilDiameter: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ coilDiameter : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the diameter of the coil spring. .. _coils: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ coils : :ref:`Int ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Number of coils in the spring, defaults to 10. This is not specifiable if the spring is of type Damper. .. _compute: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ compute : :ref:`Enum ` (PRELOAD, FREELENGTH) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies whether the Preload or the Free length is auto computed. By default Preload force is auto computed. .. _connectionRadius: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ connectionRadius : :ref:`Double ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the radius of the connection. .. _cspline: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cspline : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _csplineMethod: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ csplineMethod : :ref:`Enum ` (AKIMA, CUBIC, LINEAR) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the type of interpolation method to use. Types can be Akima, Cubic or Linear. .. _damperColor: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ damperColor : :ref:`Color ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the color of the damper of the spring. .. _damperScale: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ damperScale : :ref:`Double ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use to increase the damper diameter relative to the spring diameter. The value must be greater than 0, or less than or equal to 1, defaults to 0.5. .. _diameter: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diameter : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Used to change the diameter of the coil spring. .. _direction: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ direction : :ref:`Direction ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns or sets the direction of the object. .. _entity1: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ entity1 : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the starting endpoint of the coil spring is attached to a Feature, Joint or a Fastener. .. _entity2: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ entity2 : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the ending endpoint of the coil spring is attached to a Feature, Joint or a Fastener. .. _exponent: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ exponent : :ref:`Double ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Exponential value used to generate the stiffness. This property is not specifiable when the coil spring is of type Damper. .. _flipAxis: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ flipAxis : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Allows to flip the axis of the object. .. _freeLength: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ freeLength : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the length of the coil spring at resting state. .. _installedLength: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ installedLength : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the distance between the two endpoints of the coil spring. This is an auto computed value, user cannot modify it. .. _k: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ k : :ref:`Double ` (units="stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The stiffness value of the coil spring, defaults to 1000 N/m. .. _klinear: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ klinear : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Enables linear stiffness with the value specified for property k, else uses interpolation methods to get stiffness value. .. _kspline: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ kspline : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _ksplineMethod: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ksplineMethod : :ref:`Enum ` (AKIMA, CUBIC, LINEAR) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the type of interpolation method to use. Types can be Akima, Cubic or Linear. .. _location1: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ location1 : :ref:`Location ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The location of the starting endpoint of the coil spring. .. _location2: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ location2 : :ref:`Location ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The location of the end endpoint of the coil spring. .. _locked: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ locked : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If True, prevents the spring from expanding or collapsing during Motion Analysis. .. _max_damping_coeff: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ max_damping_coeff : :ref:`Double ` (units="damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the maximum damping value of the coil spring, defaults to 100 N*s/m. .. _max_penetration: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ max_penetration : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the maximum penetration depth of the coil spring, defaults to 0.0001 m. .. _mountColor: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ mountColor : :ref:`Color ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the color of the mounts added to coil spring when Parallel Mounts is enabled. .. _name: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ name : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns or sets the name of the object. It can be any text string, including spaces, although it's best to avoid using the following characters: " ' * ? and $. While these characters are allowed, they could create difficulties when you export the model to other applications. .. _parallelMounts: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ parallelMounts : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If True, creates a Cylindrical or Translational joint at the two endpoints of the spring, which prevents the entities from separating during Motion Analysis, defaults to False. .. _parallelMountsJoint: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ parallelMountsJoint : :ref:`Enum ` (CYLINDRICAL, TRANSLATIONAL) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies what type of joint to be created if Parallel Mounts is enabled. .. _parts: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ parts : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Lists all the parts the object is attached to. .. _preload: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ preload : :ref:`Double ` (units="force") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the force applied to the coil spring to expand or contract to reach its free length. .. _reverseDirection: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reverseDirection : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If True, reverses the direction of Preload force. .. _rotation: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rotation : :ref:`Double ` (units="angle") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the angle of rotation from the shaft of the object. .. _springLimits: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ springLimits : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prevent the spring from expanding or collapsing beyond its natural limits. .. _stiffness: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ stiffness : :ref:`Double ` (units="stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the spring stiffness. This property is not specifiable when the coil spring is of type Damper, defaults to 1E+06 N/m. .. _type: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ type : :ref:`Enum ` (SPRINGDAMPER, SPRING, DAMPER) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the type of Coil Spring. Coil Spring can be of type Spring Damper or only Spring or Damper, defaults to Spring Damper. .. _visible: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ visible : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the object is visible in the modeling window. Setting this on or off sets all children. Setting to True sets all the parents visible too. .. _wireDiameter: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ wireDiameter : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Used to change the diameter of wired coils around the spring. .. _writePlantSignals: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ writePlantSignals : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Generates a plant input and output signal for the coil spring. ---------------- Property Details ---------------- .. _hasDamper: .. method:: hasDamper Specifies if the coil spring has any dampers. .. _hasSpring: .. method:: hasSpring Specifies if the coil spring has any springs. .. _isGrounded: .. method:: isGrounded Specifies if the coil spring is a grounded spring or not. .. _lowerBound: .. method:: lowerBound Minimum distance between end points if springLimits enabled. .. _upperBound: .. method:: upperBound Maximum distance between end points if springLimits enabled.