pycatia.cat_mat_interfaces.material_manager

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.cat_mat_interfaces.material_manager.MaterialManager(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
MaterialManager

Interface to manage material manager object.
Role: A material manager is used to manage materials application
on geometrical objects.
apply_material_on_body(i_body: Body, i_material: Material | None, i_link_mode: int = 0) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ApplyMaterialOnBody(Body iBody,
Material iMaterial,
short iLinkMode)

Apply a Material on a Body. If Material is NULL, deletes
the material already applied on the Body.
Parameters:

  • i_body (Body) –

  • i_material (Material) –

  • i_link_mode (int) –

Return type:

None

apply_material_on_hybrid_body(i_hybrid_body: HybridBody, i_material: Material | None, i_link_mode: int = 0) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ApplyMaterialOnHybridBody(HybridBody iHybridBody,
Material iMaterial,
short iLinkMode)

Apply a Material on a Hybrid Body. If Material is NULL,
deletes the material already applied on the Hybrid Body
Parameters:
Return type:

None

apply_material_on_part(i_part: Part, i_material: Material | None, i_link_mode: int = 0) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ApplyMaterialOnPart(Part iPart,
Material iMaterial,
short iLinkMode)

Apply a Material on a Part. If Material is NULL, deletes
the material already applied on the Part
Parameters:

  • i_part (Part) –

  • i_material (Material) –

  • i_link_mode (int) –

Return type:

None

apply_material_on_product(i_product: Product, i_material: Material | None, i_link_mode: int = 0) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ApplyMaterialOnProduct(Product iProduct,
Material iMaterial,
short iLinkMode)

Apply a Material on a Product. If Material is NULL,
deletes the material already applied on the Product
Parameters:
Return type:

None

apply_material_on_user_material(i_user_material: AnyObject, i_material: Material | None, i_link_mode: int = 0) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ApplyMaterialOnUserMaterial(AnyObject iUserMaterial,
Material iMaterial,
short iLinkMode)

Apply a Material on a User Material (Analysis entity).
Warning:
iUserMaterial should be a CATIAAnalysisEntity object. If
Material is NULL, deletes the material already applied on
the User Material
Parameters:
Return type:

None

get_material_on_body(i_body: Body) → Material

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetMaterialOnBody(Body iBody,
Material oMaterial)

Get a Material on a Body. Material returned is NULL if no
material is applied on the Body
Parameters:
Return type:

None

get_material_on_hybrid_body(i_hybrid_body: HybridBody) → Material

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetMaterialOnHybridBody(HybridBody iHybridBody,
Material oMaterial)

Get a Material on a Hybrid Body. Material returned is
NULL if no material is applied on the Hybrid Body
Parameters:
Return type:

None

get_material_on_part(i_part: Part) → Material

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetMaterialOnPart(Part iPart,
Material oMaterial)

Get a Material on a Part. Material returned is NULL if no
material is applied on the Part
Parameters:
Return type:

None

get_material_on_product(i_product: Product) → Material

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetMaterialOnProduct(Product iProduct,
Material oMaterial)

Get a Material on a Product. Material returned is NULL if
no material is applied on the Product
Parameters:
Return type:

None

get_material_on_user_material(i_user_material: AnyObject) → Material

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetMaterialOnUserMaterial(AnyObject iUserMaterial,
Material oMaterial)

Get a Material on a User Material (Analysis entity).
Warning: iUserMaterial should be a CATIAAnalysisEntity
object. Material returned is NULL if no material is
applied on the User Material
Parameters:
Return type:

None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ReplaceMaterialLinks(Material iMaterial1,
Material iMaterial2)

In current session, replace all links towards a material 1
with a link towards an other material 2. N.B. Both
materials entered should be in a material library.
Parameters:
Return type:

None