======================== Joint (hwx.inspire.core) ======================== Joint connect parts together while allowing movement at the joint location. Every joint has a type, such as Pin or Hinge, and state, which can be set to Locked, Active, or Free. ---------- Attributes ---------- +-------------------------------------+-------------------------------------+-------------------------------------+ | active_: Bool | activeForStaticAnalysis_: Bool | angle_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | autoCalculateAllowableForces_: Bool | axialForce_: Double | axialStiffness_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | ballRadius_: Double | behavior_: Enum | bendingArm_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | bristleStiffness_: Double | c_: Double | calculateGeometryParams_: Bool | +-------------------------------------+-------------------------------------+-------------------------------------+ | color_: Color | connectionRadius_: Double | contact_: Attribute | +-------------------------------------+-------------------------------------+-------------------------------------+ | ct_: Double | ctx_: Double | cty_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | ctz_: Double | cx_: Double | cy_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | cz_: Double | dampingCoefficient_: Double | dynamicCoefficient_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | effectType_: Enum | enableAllowableForces_: Bool | enableFriction_: Bool | +-------------------------------------+-------------------------------------+-------------------------------------+ | enableMoment_: Bool | enablePreload_: Bool | enablePretension_: Bool | +-------------------------------------+-------------------------------------+-------------------------------------+ | enableReaction_: Bool | enableTorsional_: Bool | featureLists_: Attribute | +-------------------------------------+-------------------------------------+-------------------------------------+ | frictionArm_: Double | grounded_: Bool | initialOverlap_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | k_: Double | kt_: Double | ktx_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | kty_: Double | ktz_: Double | kx_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | ky_: Double | kz_: Double | material_: Attribute | +-------------------------------------+-------------------------------------+-------------------------------------+ | name_: Attribute | overlapDelta_: Enum | pinRadius_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | preloadForce_: Double | preloadTorque_: Double | pretensionForce_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | rateType_: Enum | reactionArm_: Double | shearForce_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | shearStiffness_: Double | state_: Enum | staticCoefficient_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | stictionTransitionVelocity_: Double | type_: Enum | viscousCoefficient_: Double | +-------------------------------------+-------------------------------------+-------------------------------------+ | visible_: Bool | | +-------------------------------------+---------------------------------------------------------------------------+ ---------- Properties ---------- +--------------+--------------+--------------+ | contactInfo_ | hasClip_ | keyFeatures_ | +--------------+--------------+--------------+ -------------- Public Methods -------------- +---------------------------------------------------------------------+ | classmethod getAllowedTypesFromKeyFeatures_ (cls, keyFeatures) | +---------------------------------------------------------------------+ | classmethod getConnectionCandidates_ (cls, keyFeatures, holes=None) | +---------------------------------------------------------------------+ | getAllowedTypes_ (self) | +---------------------------------------------------------------------+ | setValues_ (self, **kwds) | +---------------------------------------------------------------------+ ----------------- 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. .. _activeForStaticAnalysis: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ activeForStaticAnalysis : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Allows the joint to be active, during motion analysis set to static. .. _angle: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ angle : :ref:`Double ` (units="angle") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the rotational value about the axis. .. _autoCalculateAllowableForces: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ autoCalculateAllowableForces : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the allowable axial and shear forces will be manually added. .. _axialForce: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ axialForce : :ref:`Double ` (units="force") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Manually entry of the Allowable Axial Force. Based on the yield stress and the area of the hole Inspire automatically determines the maximum stress allowed for the fastener or cylindrical hole support, if autoCalculateAllowableForces is set to True. .. _axialStiffness: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ axialStiffness : :ref:`Double ` (units="stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The spring stiffness in the axial direction. .. _ballRadius: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ballRadius : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the radius of the ball joint. .. _behavior: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ behavior : :ref:`Enum ` (Default, Rigid, Flexible) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the behavior of the joint. It can be Default, Rigid or Flexible. If value is 'Default' then the behavior should be realized off a global default setting. Flexibility of the joint can be specified using k, kt, c, ct properties. .. _bendingArm: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ bendingArm : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the value of the bending moment value of arm. .. _bristleStiffness: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ bristleStiffness : :ref:`Double ` (units="stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the bristle stiffness value of the joint friction. .. _c: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ c : :ref:`Double ` (units="damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the damping value. .. _calculateGeometryParams: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ calculateGeometryParams : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Allows to manually enter dimensions for geometry parameters such as the pin radius, friction arm, and bending arm. .. _color: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ color : :ref:`Color ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The color assigned to the connector when it is displayed in the modeling window. .. _connectionRadius: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ connectionRadius : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The search radius for the connector. .. _contact: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ contact : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Contact object the joint is based on. If it is None then the joint is hole based. .. _ct: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ct : :ref:`Double ` (units="torsion_damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the torsional damping value. .. _ctx: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ctx : :ref:`Double ` (units="torsion_damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the torsional damping in the X direction. .. _cty: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cty : :ref:`Double ` (units="torsion_damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the torsional damping in the Y direction. .. _ctz: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ctz : :ref:`Double ` (units="torsion_damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the torsional damping in the Z direction. .. _cx: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cx : :ref:`Double ` (units="damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the damping in the X direction. .. _cy: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cy : :ref:`Double ` (units="damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the damping in the Y direction. .. _cz: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cz : :ref:`Double ` (units="damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the damping in the Z direction. .. _dampingCoefficient: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ dampingCoefficient : :ref:`Double ` (units="damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the damping friction coefficient of the joint. .. _dynamicCoefficient: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ dynamicCoefficient : :ref:`Double ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the dynamic friction coefficient (µd) of the joint. .. _effectType: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ effectType : :ref:`Enum ` (Stiction and Sliding, Stiction Only, Sliding Only) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the frictional effect. The frictional effects can be "Stiction and Sliding", "Stiction Only" and "Sliding Only". By default, both static and dynamic friction are considered. The 'Stiction Only' option uses only static friction, while the 'Sliding Only' option uses only dynamic friction. .. _enableAllowableForces: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ enableAllowableForces : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether to enable optimization of the selected fasteners or cylindrical hole supports. .. _enableFriction: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ enableFriction : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Allows to enable friction between the connected parts. .. _enableMoment: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ enableMoment : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Allows to enable the bending moment of the joint. .. _enablePreload: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ enablePreload : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Allows to preload value for the joint. .. _enablePretension: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ enablePretension : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether pretension is enabled. If pretension is enabled and defined, the pretension is then included as a load in all load cases. .. _enableReaction: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ enableReaction : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Allows to enable reaction of the joint. .. _enableTorsional: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ enableTorsional : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Allows to enable the torsional moment of the joint. .. _featureLists: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ featureLists : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ A nested list of features making up the holes. .. _frictionArm: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ frictionArm : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the value of the frictional value of arm. .. _grounded: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ grounded : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the connector is grounded. .. _initialOverlap: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ initialOverlap : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the intial overlap value. .. _k: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ k : :ref:`Double ` (units="stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the stiffness value. .. _kt: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ kt : :ref:`Double ` (units="torsion_stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the torsional stiffness value .. _ktx: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ktx : :ref:`Double ` (units="torsion_stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the torsional stiffness in the X direction. .. _kty: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ kty : :ref:`Double ` (units="torsion_stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the torsional stiffness in the Y direction. .. _ktz: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ktz : :ref:`Double ` (units="torsion_stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the torsional stiffness in the Z direction. .. _kx: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ kx : :ref:`Double ` (units="stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the stiffness in the X direction. .. _ky: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ky : :ref:`Double ` (units="stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the stiffness in the Y direction. .. _kz: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ kz : :ref:`Double ` (units="stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the stiffness in the Z direction. .. _material: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ material : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The material of the connector. .. _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. .. _overlapDelta: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ overlapDelta : :ref:`Enum ` (Constant, Increase, Decrease) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies options to how to overlap delta value for friction. The options can be "Constant", "Increase", or "Decrease". .. _pinRadius: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ pinRadius : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the radius of a pin joint. .. _preloadForce: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ preloadForce : :ref:`Double ` (units="force") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the preload force value of the joint. .. _preloadTorque: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ preloadTorque : :ref:`Double ` (units="moment") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the preload torque value of the joint. .. _pretensionForce: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ pretensionForce : :ref:`Double ` (units="force") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The magnitude for the pretension force. Applying pretension to bolted and screwed connections allows a more complete understanding of the behavior of a structure. Often, these preloads are of a significant magnitude and can influence design decisions. Typical examples are clamping structures, such as bearing housings or bicycle handlebars and seat-posts. In engines, cylinder bore distortion can be a critical design requirement highly influenced by the loads generated by the bolt down of the cylinder head. .. _rateType: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rateType : :ref:`Enum ` (Global, Basic, Advanced) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies type of rate used by the joint. It can be Global, Basic or Advanced Rates. .. _reactionArm: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reactionArm : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the value of the reaction value of arm. .. _shearForce: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ shearForce : :ref:`Double ` (units="force") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Manually entry of the Allowable Shear Force. Inspire automatically determines the maximum force allowed for the fastener or cylindrical hole support, if autoCalculateAllowableForces is set to True. .. _shearStiffness: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ shearStiffness : :ref:`Double ` (units="stiffness") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The spring stiffness in the shearing direction. .. _state: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ state : :ref:`Enum ` (Locked, Active, Free) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the state of the joint. It can be set to Locked, Active, or Free. - Select Locked to prevent movement in the joint. - Select Active to allow the joint to function normally. - Select Free if you want the mechanism to behave as if the joint is not there. .. _staticCoefficient: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ staticCoefficient : :ref:`Double ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the static friction coefficient (µs) of the joint. .. _stictionTransitionVelocity: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ stictionTransitionVelocity : :ref:`Double ` (units="velocity") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the joint velocity at which the friction effect transitions from dynamic friction to static friction. .. _type: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ type : :ref:`Enum ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The type of the connection. Call getAllowedTypes to see which are the allowed types. .. _viscousCoefficient: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ viscousCoefficient : :ref:`Double ` (units="damping") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the viscous friction coefficient of the joint. .. _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. ---------------- Property Details ---------------- .. _contactInfo: .. method:: contactInfo Returns a dictionary with contact information of the joint. .. _hasClip: .. method:: hasClip Determines whether the joint have a clip preventing translation along the hole axis. Will be True for Pin based joint types and False for Sliding Pin based joint types. Not applicable for contact based joints. .. _keyFeatures: .. method:: keyFeatures General classification of referenced features by the joint. It can be - Aligned holes - Single Holes - Cylindrical Pairs - Spherical Pairs - Planar Pairs - Multi-Planar Pairs - Unknown Pairs -------------- Method Details -------------- .. _getAllowedTypesFromKeyFeatures: .. classmethod:: getAllowedTypesFromKeyFeatures(cls, keyFeatures) Return a list of valid joint types for a given keyFeatures. :param keyFeatures: Filters the contact type based on keyFeatures. Refer keyFeatures property for valid list of keyFeatures. :type keyFeatures: str :returns: Allowed types for Joint. :rtype: List .. _getConnectionCandidates: .. classmethod:: getConnectionCandidates(cls, keyFeatures, holes=None) Returns a list of objects that are valid connection candidates to create a joint. :param keyFeatures: Filters the contact type based on keyFeatures. Refer keyFeatures property for valid list of keyFeatures. :type keyFeatures: str :param holes: List of hole features to find connection candidates. :type holes: Holes, list[list[Feature]] :returns: All valid connection candidates from the key features. :rtype: ConnectionCandidates .. _getAllowedTypes: .. method:: getAllowedTypes(self) Returns a list of allowed realization types of joint. This is a subset of type depending on the contact. .. _setValues: .. method:: setValues(self, **kwds) Sets attribute on name and value pairs in order of attributes defined.