============================= Occurrence (hwx.inspire.core) ============================= Base class for Model, Assembly and Part. ---------- 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 ---------- +--------------------------+--------------------------+--------------------------+ | axisAlignedBoundingBox_ | beadPatterns_ | cogConstraints_ | +--------------------------+--------------------------+--------------------------+ | concentratedMasses_ | displacementConstraints_ | drawDirections_ | +--------------------------+--------------------------+--------------------------+ | enforcedDisplacements_ | grounded_ | location_ | +--------------------------+--------------------------+--------------------------+ | minBoundingBox_ | rotations_ | spiders_ | +--------------------------+--------------------------+--------------------------+ | symmetryConstraints_ | temperatures_ | | +--------------------------+--------------------------+--------------------------+ -------------- Public Methods -------------- +----------------------------------------+ | destroy_ (self) | +----------------------------------------+ | save_ (self, file) | +----------------------------------------+ | setAnimationPosition_ (self, position) | +----------------------------------------+ ----------------- 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 ---------------- .. _axisAlignedBoundingBox: .. method:: axisAlignedBoundingBox Returns the bounding box aligned to the axis of the object. .. _beadPatterns: .. method:: beadPatterns List of BeadPatterns in the part/assembly .. _cogConstraints: .. method:: cogConstraints List of COG Constraints in part/assembly .. _concentratedMasses: .. method:: concentratedMasses List of Concentrated Masses in part/assembly .. _displacementConstraints: .. method:: displacementConstraints List of Displacement Constraints in part/assembly .. _drawDirections: .. method:: drawDirections List of the DrawDirections in the part/assembly. .. _enforcedDisplacements: .. method:: enforcedDisplacements List of Enforced Displacements in part/assembly .. _grounded: .. method:: grounded Determines whether the part is grounded. .. _location: .. method:: location Returns origin of the object as a Point. .. _minBoundingBox: .. method:: minBoundingBox Returns the minimum bounding box. Args: occs (Union[Feature, Part, Assembly]): Objects to bound. Returns: hwBox3: The bounding box. .. _rotations: .. method:: rotations List of Rotations in part/assembly .. _spiders: .. method:: spiders List of Connectors in part/assembly .. _symmetryConstraints: .. method:: symmetryConstraints List of SymmetryConstraints in the part/assembly .. _temperatures: .. method:: temperatures List of Temperatures in part/assembly -------------- Method Details -------------- .. _destroy: .. method:: destroy(self) Destroys occurrences from the model. .. _save: .. method:: save(self, file) Save the Part 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 .. _setAnimationPosition: .. method:: setAnimationPosition(self, position) Sets the position of the part during an animation. position as 'None' will revert the part back to its modelling position. :param position: Position is a Matrix44 or something that can be cast to a Matrix44. :type position: Matrix44