=================================== GeneralConnector (hwx.inspire.core) =================================== Baseclass for objects which connect 1 or 2 other objects (usually Features). Can be in one of 2 modes as specified by connectorMode property. Face - Connected entities must be a FeatureCurve or FeatureArea. The connector is attached to the feature at 'location1' and sticks out in 'direction'. 'entity2' isn't used to orient the connector unless both features are holes in which case 'direction' is ignored and the connector goes through both holes. 'location2' isn't used at all. PointToPoint - Connector extends from location1 to location2. 'direction' isn't used. ---------- Attributes ---------- +----------------------------+----------------------------+----------------------------+ | active_: Bool | clevisPinHoles_: Attribute | connectionRadius_: Double | +----------------------------+----------------------------+----------------------------+ | direction_: Direction | entity1_: Attribute | entity2_: Attribute | +----------------------------+----------------------------+----------------------------+ | flipAxis_: Bool | location1_: Location | location2_: Location | +----------------------------+----------------------------+----------------------------+ | name_: Attribute | parts_: Attribute | rotation_: Double | +----------------------------+----------------------------+----------------------------+ | visible_: Bool | | +----------------------------+---------------------------------------------------------+ ---------- Properties ---------- +-----------+-----------+-----------+ | axis_ | features_ | location_ | +-----------+-----------+-----------+ | position_ | | +-----------+-----------------------+ -------------- Public Methods -------------- +--------------------------------------------------+ | classmethod getPart_ (cls, obj) | +--------------------------------------------------+ | classmethod isValidConnection_ (cls, connection) | +--------------------------------------------------+ | flip_ (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. .. _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. .. _connectionRadius: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ connectionRadius : :ref:`Double ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the radius of the connection. .. _direction: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ direction : :ref:`Direction ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns or sets the direction of the object. .. _entity1: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ entity1 : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The first feature entity connector is attached to. .. _entity2: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ entity2 : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The second feature entity connector is attached to. .. _flipAxis: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ flipAxis : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Allows to flip the axis of the object. .. _location1: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ location1 : :ref:`Location ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the location of the connector object wrt to entity1. .. _location2: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ location2 : :ref:`Location ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the location of the connector object wrt to entity2. .. _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 ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Lists all the parts the object is attached to. .. _rotation: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rotation : :ref:`Double ` (units="angle") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the angle of rotation from the shaft of the object. .. _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 ---------------- .. _axis: .. method:: axis Specifies two points along the connector. This affects the connectors location and position. .. _features: .. method:: features Returns the features associated with the connector object. .. _location: .. method:: location Specifies the location of the connector object. For PointToPoint and hole based Face mode connectors this is the center of the object / axis. For Face mode connectors attached to a non hole face this the location1. Location is not necessarily the same as the origin of the position. .. _position: .. method:: position Specifies the objects position in global space. This affects where the move tool will show up. -------------- Method Details -------------- .. _getPart: .. classmethod:: getPart(cls, obj) Returns the part associated with the specified object. .. _isValidConnection: .. classmethod:: isValidConnection(cls, connection) Can Face mode connector be created out of passed connection object - Joint/Fastener, Hole, ... .. _flip: .. method:: flip(self) Swaps the two location end points of the connector.