=========================== 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_ | parts_ | +-------------+-------------+-------------+ | sketches_ | | +-------------+---------------------------+ -------------- Public Methods -------------- +-----------------------------------------------------------------------+ | classmethod getClass_ (cls, className) | +-----------------------------------------------------------------------+ | autoColorParts_ (self) | +-----------------------------------------------------------------------+ | destroy_ (self) | +-----------------------------------------------------------------------+ | getAllChildren_ (self, type=None, **kwds) | +-----------------------------------------------------------------------+ | getCenterOfGravity_ (self, includeGround=True) | +-----------------------------------------------------------------------+ | getChild_ (self, name=None, recursive=False, **kwds) | +-----------------------------------------------------------------------+ | getChildren_ (self, type=None, recursive=False, sorted=False, **kwds) | +-----------------------------------------------------------------------+ | getDependents_ (self, recursive=False, **kwds) | +-----------------------------------------------------------------------+ | getFeature_ (self, name=None) | +-----------------------------------------------------------------------+ | getFeatures_ (self, type=None, **kwds) | +-----------------------------------------------------------------------+ | getMass_ (self, includeGround=True) | +-----------------------------------------------------------------------+ | getReferences_ (self, recursive=False, **kwds) | +-----------------------------------------------------------------------+ | isa_ (self, type=None, filter=None, name=None, wildcard=None, **kwds) | +-----------------------------------------------------------------------+ | meshInfo_ (self) | +-----------------------------------------------------------------------+ | modelPositions_ (self) | +-----------------------------------------------------------------------+ | save_ (self, file) | +-----------------------------------------------------------------------+ ----------------- 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 graphics 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: .. property:: assemblies list[Assembly]: Descendent assemblies. .. _features: .. property:: features list[Feature]: Features from all descendent parts. .. _parts: .. property:: parts list[Part]: Descendent parts. .. _sketches: .. property:: sketches list[SketchPart]: Descendent sketches. -------------- Method Details -------------- .. _getClass: .. classmethod:: getClass(cls, className) Returns the class of the object. It can be simple or qualified (with namespace). If the name is simple, we prepend the cls.namespace. :param className: The class name. :type className: Union[Part, Occurrence, Named..] :returns: The class for the specified className. :rtype: Union[Part, Occurrence, Named..] .. _autoColorParts: .. method:: autoColorParts(self) Automatically assigns different colors to all the parts in the assembly. .. _destroy: .. method:: destroy(self) Destroys assemblies from the model. .. _getAllChildren: .. method:: getAllChildren(self, type=None, **kwds) Returns a list of all children that matches the specified type. :param type: Filter to use to get the children based on object type. :type type: list[Named] :param \*\*kwds: Additional keyword arguments to match other attributes of the object. :returns: The list of children that satisfy the supplied filters. :rtype: list[Union[Part, Motor, BoundaryCondition, ...]] .. _getCenterOfGravity: .. method:: getCenterOfGravity(self, includeGround=True) Returns the centre of gravity of the assembly. :param includeGround: Include ground parts? :type includeGround: bool :returns: Point .. _getChild: .. method:: getChild(self, name=None, recursive=False, **kwds) Returns the child of the object which matches the specified unique name. :param name: The name of the child object. :type name: str :param recursive: Search all descendents. :type recursive: bool :param \*\*kwds: Additional keyword arguments to match attributes of the object. :returns: The child object which satisfies the specified filters. :rtype: Named .. _getChildren: .. method:: getChildren(self, type=None, recursive=False, sorted=False, **kwds) Returns a list of children that is of the specified type. :param type: Filter objects by class. :type type: Type[Named] :param recursive: True to get all descendent Parts and Assemblies. :type recursive: bool :param sorted: Sort the children base on id. :type sorted: bool :returns: list[Named] .. _getDependents: .. method:: getDependents(self, recursive=False, **kwds) Get objects that reference this object through a Reference attribute. :param recursive: :type recursive: bool :param \*\*kwds: Filter objects using isa. :returns: set[Named] .. _getFeature: .. method:: getFeature(self, name=None) Find feature by its __str__/__repr__. :param name: :type name: str :returns: Feature .. _getFeatures: .. method:: getFeatures(self, type=None, **kwds) Returns features that matches the specified filters. :param type: The type of feature to return. :type type: Type[Feature] :param \*\*kwds: Additional keyword arguments to match other attributes. :returns: A list of features that satisfies all the filter criteria. :rtype: list [Feature] .. _getMass: .. method:: getMass(self, includeGround=True) Returns the mass of the assembly. :param includeGround: Include ground parts. :type includeGround: bool :returns: float .. _getReferences: .. method:: getReferences(self, recursive=False, **kwds) Get objects this object references through a Reference attribute. :param recursive: :type recursive: bool :param \*\*kwds: Filter objects using isa. :returns: set[Named] .. _isa: .. method:: isa(self, type=None, filter=None, name=None, wildcard=None, **kwds) Determines if the object matches the specified settings or not. :param type: The type of the object. :type type: Union[Part, Assembly, Contact..] :param filter: Return value of specified callback method. :type filter: method :param name: Name that matches exactly with object name. :type name: str :param wildcard: A pattern to match exactly with the object name. :type wildcard: str :param \*\*kwds: Additional keyword arguments to match other attributes. :returns: True, if a match is found, otherwise False. :rtype: bool .. _meshInfo: .. method:: meshInfo(self) Mesh infomation for an assembly or Part. .. _modelPositions: .. method:: modelPositions(self) Forces all objects to return the original model positions instead of the current analysis positions. Useful when defining draw methods on GeneralObjects where behaviour is different while animating. .. _save: .. method:: save(self, file) Save the Assembly in the specified file. :param file: File name and path, where the file needs to be saved. Valid file extensions are: '.x_b', '.x_t', '.xmt_bin', '.xmt_txt', '.sat', '.sab', '.iges', '.igs', '.stl', '.step', '.stp', '.obj', '.vrml', '.vrl'. :type file: str