pycatia.cat_mat_interfaces.material

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.Material(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

Material

Represents a Material object.

property analysis_material: AnalysisMaterial

Note

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

o Property AnalysisMaterial() As AnalysisMaterial (Read Only)

Returns the analysis material object from the current

material.

Return type:

AnalysisMaterial

copy_rendering_data_from(i_rendering_material: RenderingMaterial) → None

Note

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

o Sub CopyRenderingDataFrom(RenderingMaterial

iRenderingMaterial)

Copy rendering data from a material to the current

material.

Parameters:

i_rendering_material (RenderingMaterial) –

Return type:

None

create_analysis_data(i_label: str) → AnalysisMaterial

Note

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

o Func CreateAnalysisData(CATBSTR iLabel) As

AnalysisMaterial

Create a default analysis material on the current

material.

Parameters:

i_label (str) –

Return type:

AnalysisMaterial

create_rendering_data() → RenderingMaterial

Note

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

o Func CreateRenderingData() As RenderingMaterial

Create a default rendering material on the current

material.

Return type:

RenderingMaterial

exist_analysis_data() → int

Note

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

o Func ExistAnalysisData() As short

Returns true if a analysis material exists on the current

material.

Return type:

int

exist_rendering_data() → int

Note

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

o Func ExistRenderingData() As short

Returns true if a rendering material exists on the current

material.

Return type:

int

get_icon(i_path: str) → None

Note

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

o Sub GetIcon(CATBSTR iPath)

Write the icon of a material to disc. The parameter is the

path of the folder where the JPEG is going to be written

Ex : E:folder

Parameters:

i_path (str) –

Return type:

None

put_icon(i_path: str) → None

Note

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

o Sub PutIcon(CATBSTR iPath)

Read the icon of a material from JPEG file. The parameter

is the path of the folder where the JPEG is going to be

read Ex : E:folder

Parameters:

i_path (str) –

Return type:

None

property rendering_material: RenderingMaterial

Note

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

o Property RenderingMaterial() As RenderingMaterial (Read

Only)

Returns the rendering material object from the current

material.

Return type:

RenderingMaterial