===========================
Material (hwx.inspire.core)
===========================

A material is the physical substance that a part is made of, such as steel,
aluminum, or plastic.

The type of material does not determine the visual appearance of a part,
only its physical properties.

Base class for all user defined material.

----------
Attributes
----------

  +---------------------------+---------------------------+---------------------------+
  | active_: Bool             | density_: Double          | name_: Attribute          |
  +---------------------------+---------------------------+---------------------------+
  | poissonRatio_: Double     | stress_: Double           | thermalExpansion_: Double |
  +---------------------------+---------------------------+---------------------------+
  | visible_: Bool            | youngModulus_: Double     |                           |
  +---------------------------+---------------------------+---------------------------+

--------------
Public Methods
--------------

  +-----------------------------------------+
  | classmethod get_ (cls, material=None)   |
  +-----------------------------------------+
  | classmethod getDefault_ (cls)           |
  +-----------------------------------------+
  | classmethod getMaterials_ (cls)         |
  +-----------------------------------------+
  | classmethod setDefault_ (cls, material) |
  +-----------------------------------------+
  | destroy_ (self)                         |
  +-----------------------------------------+

-----------------
Attribute Details
-----------------

.. _active:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
active : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns or sets the object activeness.

Setting this on or off sets all children.
Setting to True sets all the parents active too.

.. _density:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
density : :ref:`Double <Double (hwx.inspire)>` (units="density")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies density as a mass of a unit volume of a material.

.. _name:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
name : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


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.

.. _poissonRatio:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
poissonRatio : :ref:`Double <Double (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Poisson ratio is the ratio of the change in the width per unit
width of a material, to the change in its length per unit length.

.. _stress:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
stress : :ref:`Double <Double (hwx.inspire)>` (units="stress")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the yield stress of the material.

The stress value at which the behaviour of the material changes from elastic to plastic.
It is the minimum stress at which a solid will undergo permanent deformation
or plastic flow without a significant increase in the load or external force.

.. _thermalExpansion:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
thermalExpansion : :ref:`Double <Double (hwx.inspire)>` (units="e")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the heat value on the material, when the size and volume
increase in small increments.

.. _visible:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
visible : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


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.

.. _youngModulus:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
youngModulus : :ref:`Double <Double (hwx.inspire)>` (units="stress")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Specifies the young modulus of the material as a ratio of tensile stress and tensile strain.

This property of the material tells, how easily the material can stretch and deform.


--------------
Method Details
--------------

.. _get:
.. classmethod:: get(cls, material=None)

Returns the material by its name.

:param material: Name of the material.
:type material: str

:returns: Material found by its name.
:rtype: Material


.. _getDefault:
.. classmethod:: getDefault(cls)

Returns project default material.

:returns: The default material.
:rtype: Material


.. _getMaterials:
.. classmethod:: getMaterials(cls)

Returns a dictionary of the defined material keys to the material name.

:returns: Return a dictionary of all the material keyed by name.
:rtype: OrderedDict


.. _setDefault:
.. classmethod:: setDefault(cls, material)

Sets projects default material.

:param material: Material to be set for the project.
:type material: Material

:returns: The default material.
:rtype: Material


.. _destroy:
.. method:: destroy(self)

Removes the material from the database.

:returns: True, if deleted, else False.
:rtype: bool