========================== Contact (hwx.inspire.core) ========================== Connection between two parts by the contact of features. Contacts indicate whether neighboring surfaces should be bonded, contacting, or have no contact. ---------- Attributes ---------- +-------------------------------+-------------------------------+-------------------------------+ | active_: Bool | connectionRadius_: Double | contactType_: Enum | +-------------------------------+-------------------------------+-------------------------------+ | definitionType_: Attribute | name_: Attribute | parts_: Attribute | +-------------------------------+-------------------------------+-------------------------------+ | primaryFeatures_: Attribute | searchDistance_: Double | secondaryFeatures_: Attribute | +-------------------------------+-------------------------------+-------------------------------+ | visible_: Bool | | +-------------------------------+---------------------------------------------------------------+ ---------- Properties ---------- +----------------+----------------+----------------+ | contactData_ | primaryPart_ | secondaryPart_ | +----------------+----------------+----------------+ -------------- Public Methods -------------- +-------------------------+ | getContactJoint_ (self) | +-------------------------+ ----------------- 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. .. _connectionRadius: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ connectionRadius : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The search radius for the connector. .. _contactType: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ contactType : :ref:`Enum ` (none, bonded, sliding) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Defines contact type. The options are bonded, sliding (Contacting in legend), or none (No Contact in legend). - Select bonded if parts are bonded or glued together. - Select sliding if there is relative sliding between the parts. - Select none if parts are close but you don't want them to have contact. .. _definitionType: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ definitionType : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the contact definition type, they can be of type 'Unknown', 'Surface' and 'Part'. .. _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. .. _parts: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ parts : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The parts in contact. .. _primaryFeatures: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ primaryFeatures : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ List of features from the primary entity. .. _searchDistance: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ searchDistance : :ref:`Double ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The search distance is a global search threshold that uses default tolerances to find locations where joints can be created. When the search distance is manually set, the contacts with a minimum separation equal to search distance or less are detected. .. _secondaryFeatures: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ secondaryFeatures : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ List of features from the secondary entity. .. _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 ---------------- .. _contactData: .. method:: contactData Information about the contact including the contact regions mesh. .. _primaryPart: .. method:: primaryPart The part associated with the primary features. .. _secondaryPart: .. method:: secondaryPart The part associated with the secondary features. -------------- Method Details -------------- .. _getContactJoint: .. method:: getContactJoint(self) Returns the joint that uses this contact.