pycatia.in_interfaces.vrml_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384

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.in_interfaces.vrml_setting_att.VrmlSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

VrmlSettingAtt

The interface to access a CATIAVrmlSettingAtt.

This interface may be used to read or modify in the

CATIAToolsOptionGeneralCompatibility…. the settings values of the VRML

sheet.

property export_edges: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ExportEdges() As boolean

Returns or sets the ExportEdges parameter (exported Vrml files will or will

not contains edge informations).

Parameters:

oExportEdges

- iExportEdges Value of ExportEdges parameter. Legal

values:

TRUE : exported Vrml files will contain edge informations.

FALSE : exported Vrml files will not contain edge informations.

Return type:

bool

property export_normals: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ExportNormals() As boolean

Returns or sets the ExportNormals parameter (exported Vrml files will or

will not contains normal informations).

Parameters:

oExportNormals

- iExportNormals Value of ExportNormals parameter. Legal

values:

TRUE : exported Vrml files will contain normal informations.

FALSE : exported Vrml files will not contain normal informations.

Return type:

bool

property export_texture: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ExportTexture() As boolean

Returns or sets the ExportTexture parameter (exported Vrml files will or

will not contains texture informations).

Parameters:

oExportTexture

- iExportTexture Value of ExportTexture parameter. Legal

values:

TRUE : exported Vrml files will contain texture informations.

FALSE : exported Vrml files will not contain texture informations.

Return type:

bool

property export_texture_file: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ExportTextureFile() As long

Returns or sets the ExportTextureFile parameter (Textures will be exported

in the vrml file containing the geometry or in external

files).

Parameters:

oExportTextureFile

- iExportTextureFile Value of ExportTextureFile parameter. Legal

values:

0 : Textures are exported in the Vrml file containing the geometry.

1 : Texture are exported in external files.

Return type:

int

property export_texture_format: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ExportTextureFormat() As long

Returns or sets the ExportTextureFormat parameter.

Parameters:

oExportTextureFormat

- iExportTextureFormat Value of ExportTextureFormat parameter.

Legal values:

NOT APPLICABLE

Return type:

int

property export_version: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ExportVersion() As long

Returns or sets the ExportVersion parameter (version of exported Vrml

files).

Parameters:

oExportVersion

- iExportVersion Value of Import Unit parameter. Legal

values:

1 : VRML 1.0.

2 : VRML 97 (VRML 2.0).

Return type:

int

get_export_background_color(io_r: int, io_g: int, io_b: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetExportBackgroundColor(long ioR,

long ioG,

long ioB)

Returns the ExportBackgroundColor parameter (Background color of exported

Vrml files). Value of ExportBackgroundColor parameter. Legal

values:

R [0,255] G [0,255] B [0,255]

Parameters:

• io_r (int) –

• io_g (int) –

• io_b (int) –

Return type:

None

get_export_background_color_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetExportBackgroundColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ExportBackgroundColor setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_export_edges_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetExportEdgesInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ExportEdges setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_export_normals_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetExportNormalsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ExportNormals setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_export_texture_file_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetExportTextureFileInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ExportTextureFile setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_export_texture_format_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetExportTextureFormatInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ExportTextureFormat setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_export_texture_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetExportTextureInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ExportTexture setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_export_version_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetExportVersionInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ExportVersion setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_import_crease_angle_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetImportCreaseAngleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ImportCreaseAngle setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_import_unit_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetImportUnitInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ImportUnit setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

property import_crease_angle: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ImportCreaseAngle() As double

Returns or sets the ImportCreaseAngle parameter. The crease angle affects

how DEFAULT normals are generated. If the angle between the geometric normals

of two adjacent faces is less than the crease angle, normals will be calculated

so that the faces are smooth-shaded across the edge. Otherwise, normals will be

calculated so that a lighting discontinuity across the edge is

produce.

Parameters:

oImportCreaseAngle

- iImportCreaseAngle Value of ImportCreaseAngle parameter. Legal

values:

[0,inf]

Return type:

float

property import_unit: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ImportUnit() As long

Returns or sets the ImportUnit parameter (unit of imported Vrml

files).

Parameters:

oImportUnit

- iImportUnit Value of Import Unit parameter. Legal

values:

0 : Millimeter.

1 : Centimeter.

2 : Meter.

Return type:

int

set_export_background_color(i_r: int, i_g: int, i_b: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetExportBackgroundColor(long iR,

long iG,

long iB)

Sets the ExportBackgroundColor parameter (Background color of exported Vrml

files). Value of ExportBackgroundColor parameter. Legal

values:

R [0,255] G [0,255] B [0,255]

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_export_background_color_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetExportBackgroundColorLock(boolean iLocked)

Locks or unlocks the ExportBackgroundColor setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_export_edges_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetExportEdgesLock(boolean iLocked)

Locks or unlocks the ExportEdges setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_export_normals_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetExportNormalsLock(boolean iLocked)

Locks or unlocks the ExportNormals setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_export_texture_file_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetExportTextureFileLock(boolean iLocked)

Locks or unlocks the ExportTextureFile setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_export_texture_format_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetExportTextureFormatLock(boolean iLocked)

Locks or unlocks the ExportTextureFormat setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_export_texture_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetExportTextureLock(boolean iLocked)

Locks or unlocks the ExportTexture setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_export_version_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetExportVersionLock(boolean iLocked)

Locks or unlocks the ExportVersion setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_import_crease_angle_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetImportCreaseAngleLock(boolean iLocked)

Locks or unlocks the ImportCreaseAngle setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_import_unit_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetImportUnitLock(boolean iLocked)

Locks or unlocks the ImportLock setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None