pycatia.cat_rdg_interfaces.rendering_setting_att

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_rdg_interfaces.rendering_setting_att.RenderingSettingAtt(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

System.SettingController

RenderingSettingAtt

The interface to access a CATIARenderingSettingAtt.

property engine_interface: str

Note

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

o Property EngineInterface() As CATBSTR

Returns or sets the EngineInterface parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

str

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

Note

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

o Func GetEngineInterfaceInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the EngineInterface

parameter.

Role:Retrieves the state of the EngineInterface parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetOutputHeightInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the OutputHeight

parameter.

Role:Retrieves the state of the OutputHeight parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetOutputPathInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the OutputPath

parameter.

Role:Retrieves the state of the OutputPath parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetOutputSizeFromInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the OutputSizeFrom

parameter.

Role:Retrieves the state of the OutputSizeFrom parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetOutputTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the OutputType

parameter.

Role:Retrieves the state of the OutputType parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetOutputWidthInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the OutputWidth

parameter.

Role:Retrieves the state of the OutputWidth parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetSaveAutoIncrementInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the SaveAutoIncrement

parameter.

Role:Retrieves the state of the SaveAutoIncrement parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

property output_height: int

Note

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

o Property OutputHeight() As short

Returns or sets the OutputHeight parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

int

property output_path: str

Note

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

o Property OutputPath() As CATBSTR

Returns or sets the OutputPath parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

str

property output_size_from: int

Note

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

o Property OutputSizeFrom() As short

Returns or sets the OutputSizeFrom parameter.

Ensure consistency with the C++ interface to which the work is

delegated.

Parameters:

OutputSizeFrom

where to get the image size for a QuickRender. Legal

values:

1 : same size as viewpoint.

2 : fixed size. Ensure consistency with the C++ interface to which the work is delegated.

Return type:

int

property output_type: int

Note

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

o Property OutputType() As short

Returns or sets the OutputType parameter.

Ensure consistency with the C++ interface to which the work is

delegated.

Parameters:

OutputType

where to save the image after a QuickRender. Legal

values:

1 : image saved to default file.

2 : save image to specific file.

Return type:

int

property output_width: int

Note

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

o Property OutputWidth() As short

Returns or sets the OutputWidth parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

int

property save_auto_increment: bool

Note

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

o Property SaveAutoIncrement() As boolean

Returns or sets the SaveAutoIncrement parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

bool

set_engine_interface_lock(i_locked: bool) → None

Note

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

o Sub SetEngineInterfaceLock(boolean iLocked)

Locks or unlocks the EngineInterface parameter.

Role:Locks or unlocks the EngineInterface parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_output_height_lock(i_locked: bool) → None

Note

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

o Sub SetOutputHeightLock(boolean iLocked)

Locks or unlocks the OutputHeight parameter.

Role:Locks or unlocks the OutputHeight parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_output_path_lock(i_locked: bool) → None

Note

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

o Sub SetOutputPathLock(boolean iLocked)

Locks or unlocks the OutputPath parameter.

Role:Locks or unlocks the OutputPath parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_output_size_from_lock(i_locked: bool) → None

Note

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

o Sub SetOutputSizeFromLock(boolean iLocked)

Locks or unlocks the OutputSizeFrom parameter.

Role:Locks or unlocks the OutputSizeFrom parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_output_type_lock(i_locked: bool) → None

Note

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

o Sub SetOutputTypeLock(boolean iLocked)

Locks or unlocks the OutputType parameter.

Role:Locks or unlocks the OutputType parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_output_width_lock(i_locked: bool) → None

Note

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

o Sub SetOutputWidthLock(boolean iLocked)

Locks or unlocks the OutputWidth parameter.

Role:Locks or unlocks the OutputWidth parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_save_auto_increment_lock(i_locked: bool) → None

Note

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

o Sub SetSaveAutoIncrementLock(boolean iLocked)

Locks or unlocks the SaveAutoIncrement parameter.

Role:Locks or unlocks the SaveAutoIncrement parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None