=========================== Assembly (hwx.inspire.core) =========================== An assembly is a list of parts. Assemblies can contain subassemblies, allowing you to organize your model hierarchically. Parts and subassemblies within an assembly are positioned in space relative to the parent assembly. If you translate or rotate a parent assembly, its parts and subassemblies move with it. Assemblies do not have their own properties. Changing properties for an assembly actually applies the change to the individual parts within the assembly down to the lowest level in the hierarchy. Only properties common to all parts in the assembly are shown. ---------- Attributes ---------- +----------------------------+----------------------------+----------------------------+ | active_: Bool | autoCalculateCG_: Bool | autoCalculateMass_: Bool | +----------------------------+----------------------------+----------------------------+ | autoCalculateMoment_: Bool | cg_: Location | color_: Color | +----------------------------+----------------------------+----------------------------+ | detectCollisions_: Bool | ground_: Bool | ip_: Inertia | +----------------------------+----------------------------+----------------------------+ | mass_: Double | material_: Attribute | modifiable_: Bool | +----------------------------+----------------------------+----------------------------+ | morphable_: Bool | movable_: Bool | name_: Attribute | +----------------------------+----------------------------+----------------------------+ | position_: Attribute | transparency_: Double | visible_: Bool | +----------------------------+----------------------------+----------------------------+ | volume_: Double | | +----------------------------+---------------------------------------------------------+ ---------- Properties ---------- +--------------+--------------+--------------+ | assemblies_ | features_ | loads_ | +--------------+--------------+--------------+ | parts_ | rigidGroups_ | sketches_ | +--------------+--------------+--------------+ -------------- Public Methods -------------- +------------------------------------------------+ | autoColorParts_ (self) | +------------------------------------------------+ | getCenterOfGravity_ (self, includeGround=True) | +------------------------------------------------+ | getFeatures_ (self, type=None, **kwds) | +------------------------------------------------+ | getMass_ (self, includeGround=True) | +------------------------------------------------+ ----------------- 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. .. _autoCalculateCG: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ autoCalculateCG : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the center of gravity is auto calculated. .. _autoCalculateMass: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ autoCalculateMass : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the mass value is automatically calculated based upon volume and material density. .. _autoCalculateMoment: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ autoCalculateMoment : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the mass moment of inertia is automatically calculated. .. _cg: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cg : :ref:`Location ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns the object's global center of gravity as a point. .. _color: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ color : :ref:`Color ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines the color assigned to the object when it is displayed in the modeling window. The default color for parts is gray, but a different color can be assigned. .. _detectCollisions: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ detectCollisions : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether to detect collision. It prevents parts in the model from overlapping and has been enabled by default. .. _ground: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ground : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns or sets the object to be ground or immovable. .. _ip: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ip : :ref:`Inertia ` (units="massMI") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the inertial properties of this object. Resistance to change in motion (ixx, iyy, izz, ixy, izy, ixz). .. _mass: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ mass : :ref:`Double ` (units="m") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The mass of the object. .. _material: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ material : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The material of the object. Every part in the model has a material assigned to it. The default material is steel, but a different material can be assigned. .. _modifiable: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ modifiable : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the selected object can be edited. .. _morphable: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ morphable : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the selected object shape can be changed. .. _movable: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ movable : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the selected object can be translated in the modeling window or has been locked in place. .. _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. .. _position: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ position : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the global transform as a Matrix44. .. _transparency: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ transparency : :ref:`Double ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specifies the transparency of the object. Allows you to change the transparency, according to a percentage. By default, objects are 0% transparent(opaque). .. _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. .. _volume: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ volume : :ref:`Double ` (units="volume") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The volume of the object in the assembly. ---------------- Property Details ---------------- .. _assemblies: .. method:: assemblies Returns a list of assemblies. .. _features: .. method:: features Returns a list of all features from the parts in the assembly. .. _loads: .. method:: loads Returns a list of all the loads (Constraint, Force, Torque, ...) in the assembly. .. _parts: .. method:: parts Returns a list of all the parts in the assembly. .. _rigidGroups: .. method:: rigidGroups Returns a list of all rigid groups in the assembly. .. _sketches: .. method:: sketches Returns a list of all the sketches in the assembly. -------------- Method Details -------------- .. _autoColorParts: .. method:: autoColorParts(self) Automatically assigns different colors to all the parts in the assembly. .. _getCenterOfGravity: .. method:: getCenterOfGravity(self, includeGround=True) Returns the centre of gravity of the assembly. :param includeGround: Includes non-grounded parts. :type includeGround: bool :returns: The centre of gravity of the assembly. :rtype: Point .. _getFeatures: .. method:: getFeatures(self, type=None, **kwds) Returns all features that matches the specified filters. :param type: The type of features to return. :type type: Union[FeaturePoint, FeatureArea, FeatureCylindrical, ...] :param \*\*kwds: Additional keyword arguments to match other attributes. :returns: A list of features that satisfies all the filter criteria. :rtype: list [Union[FeaturePoint, FeatureArea, FeatureCylindrical, ...])] .. _getMass: .. method:: getMass(self, includeGround=True) Returns the mass of the assembly. :param includeGround: Includes non-grounded parts in mass calculation. :type includeGround: bool :returns: The mass of the assembly. :rtype: float