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.


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 : Bool

Returns or sets the object activeness.

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

density : Double (units=”density”)

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

name : 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.

poissonRatio : Double

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 : Double (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 : Double (units=”e”)

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

visible : 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.

youngModulus : Double (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

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.
classmethod getDefault(cls)

Returns project default material.

returns:The default material.
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.
classmethod setDefault(cls, material)

Sets projects default material.

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

Removes the material from the database.

returns:True, if deleted, else False.