pycatia.space_analyses_interfaces.sectioning_setting_att¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.sectioning_setting_att.SectioningSettingAtt(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

SectioningSettingAtt

The interface to access a CATIASectioningSettingAtt.

property clipping_mode: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ClippingMode() As CatSectionClippingMode

Returns or sets the ClippingMode parameter.

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

Returns:: enum cat_section_clipping_mode
Return type:: int

property display_cut_in_wireframe: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property DisplayCutInWireframe() As boolean

Returns or sets the DisplayCutInWireframe parameter.

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

Return type:: bool

get_clipping_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetClippingModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ClippingMode

parameter.

Role:Retrieves the state of the ClippingMode 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_display_cut_in_wireframe_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetDisplayCutInWireframeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DisplayCutInWireframe

parameter.

Role:Retrieves the state of the DisplayCutInWireframe 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_grid_auto_filtering_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetGridAutoFilteringInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridAutoFiltering

parameter.

Role:Retrieves the state of the GridAutoFiltering 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_grid_auto_resize_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetGridAutoResizeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridAutoResize

parameter.

Role:Retrieves the state of the GridAutoResize 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_grid_height_step_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetGridHeightStepInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridHeightStep

parameter.

Role:Retrieves the state of the GridHeightStep 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_grid_position_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetGridPositionModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridPositionMode

parameter.

Role:Retrieves the state of the GridPositionMode 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_grid_style_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetGridStyleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridStyle

parameter.

Role:Retrieves the state of the GridStyle 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_grid_width_step_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetGridWidthStepInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridWidthStep

parameter.

Role:Retrieves the state of the GridWidthStep 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_hide_plane_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetHidePlaneInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the HidePlane

parameter.

Role:Retrieves the state of the HidePlane 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_hide_result_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetHideResultInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the HideResult

parameter.

Role:Retrieves the state of the HideResult 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_plane_color(o_r: int, o_g: int, o_b: int) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub GetPlaneColor(long oR,

long oG,

long oB)

Returns the PlaneColor parameter.

Parameters:

oR

the red component of the color.

oG

the green component of the color.

oB

the blue component of the color.

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

delegated.

Parameters:

o_r (int) –
o_g (int) –
o_b (int) –

Return type:

None

get_plane_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 GetPlaneColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PlaneColor

parameter.

Role:Retrieves the state of the PlaneColor 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_plane_normal_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetPlaneNormalInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PlaneNormal

parameter.

Role:Retrieves the state of the PlaneNormal 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_plane_origin_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetPlaneOriginInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PlaneOrigin

parameter.

Role:Retrieves the state of the PlaneOrigin 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_section_export_type_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetSectionExportTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the SectionExportType

parameter.

Role:Retrieves the state of the SectionExportType 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_section_fill_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetSectionFillInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the SectionFill

parameter.

Role:Retrieves the state of the SectionFill 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_update_result_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetUpdateResultInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the UpdateResult

parameter.

Role:Retrieves the state of the UpdateResult 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_viewer_auto_open_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetViewerAutoOpenInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ViewerAutoOpen

parameter.

Role:Retrieves the state of the ViewerAutoOpen 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_viewer_auto_reframe_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetViewerAutoReframeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ViewerAutoReframe

parameter.

Role:Retrieves the state of the ViewerAutoReframe 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_viewer_lock2_d_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetViewerLock2DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ViewerLock2D

parameter.

Role:Retrieves the state of the ViewerLock2D 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_window_default_height_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetWindowDefaultHeightInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WindowDefaultHeight

parameter.

Role:Retrieves the state of the WindowDefaultHeight 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_window_default_width_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetWindowDefaultWidthInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WindowDefaultWidth

parameter.

Role:Retrieves the state of the WindowDefaultWidth 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_window_open_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetWindowOpenModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WindowOpenMode

parameter.

Role:Retrieves the state of the WindowOpenMode 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 grid_auto_filtering: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property GridAutoFiltering() As boolean

Returns or sets the GridAutoFiltering parameter.

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

Return type:: bool

property grid_auto_resize: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property GridAutoResize() As boolean

Returns or sets the GridAutoResize parameter.

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

Return type:: bool

property grid_height_step: float¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property GridHeightStep() As float

Returns or sets the GridHeightStep parameter.

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

Return type:: float

property grid_position_mode: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property GridPositionMode() As CatGridPositionMode

Returns or sets the GridPositionMode parameter.

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

Returns:: enum cat_grid_position_mode
Return type:: int

property grid_style: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property GridStyle() As CatSectionGridStyle

Returns or sets the GridStyle parameter.

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

Returns:: enum cat_section_grid_style
Return type:: int

property grid_width_step: float¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property GridWidthStep() As float

Returns or sets the GridWidthStep parameter.

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

Return type:: float

property hide_plane: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property HidePlane() As boolean

Returns or sets the HidePlane parameter.

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

Return type:: bool

property hide_result: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property HideResult() As boolean

Returns or sets the HideResult parameter.

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

Return type:: bool

property plane_normal: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property PlaneNormal() As CatSectionPlaneNormal

Returns or sets the PlaneNormal parameter.

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

Returns:: enum cat_section_plane_normal
Return type:: int

property plane_origin: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property PlaneOrigin() As CatSectionPlaneOrigin

Returns or sets the PlaneOrigin parameter.

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

Returns:: enum cat_section_plane_origin
Return type:: int

property section_export_type: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property SectionExportType() As boolean

Returns or sets the SectionExportType parameter.

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

Return type:: bool

property section_fill: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property SectionFill() As boolean

Returns or sets the SectionFill parameter.

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

Return type:: bool

set_clipping_mode_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetClippingModeLock(boolean iLocked)

Locks or unlocks the ClippingMode parameter.

Role:Locks or unlocks the PlaneOrigin 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_display_cut_in_wireframe_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetDisplayCutInWireframeLock(boolean iLocked)

Locks or unlocks the DisplayCutInWireframe parameter.

Role:Locks or unlocks the DisplayCutInWireframe 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_grid_auto_filtering_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetGridAutoFilteringLock(boolean iLocked)

Locks or unlocks the GridAutoFiltering parameter.

Role:Locks or unlocks the GridAutoFiltering 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_grid_auto_resize_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetGridAutoResizeLock(boolean iLocked)

Locks or unlocks the GridAutoResize parameter.

Role:Locks or unlocks the GridAutoResize 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_grid_height_step_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetGridHeightStepLock(boolean iLocked)

Locks or unlocks the GridHeightStep parameter.

Role:Locks or unlocks the GridHeightStep 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_grid_position_mode_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetGridPositionModeLock(boolean iLocked)

Locks or unlocks the GridPositionMode parameter.

Role:Locks or unlocks the GridPositionMode 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_grid_style_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetGridStyleLock(boolean iLocked)

Locks or unlocks the GridStyle parameter.

Role:Locks or unlocks the GridStyle 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_grid_width_step_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetGridWidthStepLock(boolean iLocked)

Locks or unlocks the GridWidthStep parameter.

Role:Locks or unlocks the GridWidthStep 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_hide_plane_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetHidePlaneLock(boolean iLocked)

Locks or unlocks the HidePlane parameter.

Role:Locks or unlocks the HidePlane 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_hide_result_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetHideResultLock(boolean iLocked)

Locks or unlocks the HideResult parameter.

Role:Locks or unlocks the HideResult 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_plane_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 SetPlaneColor(long iR,

long iG,

long iB)

Sets the PlaneColor parameter.

Parameters:

oR

the red component of the color.

oG

the green component of the color.

oB

the blue component of the color.

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

delegated.

Parameters:

i_r (int) –
i_g (int) –
i_b (int) –

Return type:

None

set_plane_color_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetPlaneColorLock(boolean iLocked)

Locks or unlocks the PlaneColor parameter.

Role:Locks or unlocks the PlaneColor 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_plane_normal_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetPlaneNormalLock(boolean iLocked)

Locks or unlocks the PlaneNormal parameter.

Role:Locks or unlocks the PlaneNormal 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_plane_origin_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetPlaneOriginLock(boolean iLocked)

Locks or unlocks the PlaneOrigin parameter.

Role:Locks or unlocks the PlaneOrigin 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_section_export_type_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetSectionExportTypeLock(boolean iLocked)

Locks or unlocks the SectionExportType parameter.

Role:Locks or unlocks the SectionExportType 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_section_fill_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetSectionFillLock(boolean iLocked)

Locks or unlocks the SectionFill parameter.

Role:Locks or unlocks the SectionFill 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_update_result_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetUpdateResultLock(boolean iLocked)

Locks or unlocks the UpdateResult parameter.

Role:Locks or unlocks the UpdateResult 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_viewer_auto_open_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetViewerAutoOpenLock(boolean iLocked)

Locks or unlocks the ViewerAutoOpen parameter.

Role:Locks or unlocks the ViewerAutoOpen 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_viewer_auto_reframe_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetViewerAutoReframeLock(boolean iLocked)

Locks or unlocks the ViewerAutoReframe parameter.

Role:Locks or unlocks the ViewerAutoReframe 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_viewer_lock2_d_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetViewerLock2DLock(boolean iLocked)

Locks or unlocks the ViewerLock2D parameter.

Role:Locks or unlocks the ViewerLock2D 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_window_default_height_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetWindowDefaultHeightLock(boolean iLocked)

Locks or unlocks the WindowDefaultHeight parameter.

Role:Locks or unlocks the WindowDefaultHeight 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_window_default_width_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetWindowDefaultWidthLock(boolean iLocked)

Locks or unlocks the WindowDefaultWidth parameter.

Role:Locks or unlocks the WindowDefaultWidth 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_window_open_mode_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetWindowOpenModeLock(boolean iLocked)

Locks or unlocks the WindowOpenMode parameter.

Role:Locks or unlocks the WindowOpenMode 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

property update_result: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property UpdateResult() As boolean

Returns or sets the UpdateResult parameter.

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

Return type:: bool

property viewer_auto_open: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ViewerAutoOpen() As boolean

Returns or sets the ViewerAutoOpen parameter.

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

Return type:: bool

property viewer_auto_reframe: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ViewerAutoReframe() As boolean

Returns or sets the ViewerAutoReframe parameter.

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

Return type:: bool

property viewer_lock_2d: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ViewerLock2D() As boolean

Returns or sets the ViewerLock2D parameter.

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

is delegated.

Return type:: bool

property window_default_height: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property WindowDefaultHeight() As long

Role:Retrieve section window default height if the window open mode is

catSecWindow_DefaultSize

Parameters:

oWindowDefaultHeight

Returns:

S_OK Successfully retieved the window open mode E_FAIL Failed to

retrieved the window open mode

Return type:: int

property window_default_width: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property WindowDefaultWidth() As long

Role:Retrieve section window default width if the window open mode is

catSecWindow_DefaultSize

Parameters:

oWindowDefaultWidth

Returns:

S_OK Successfully retieved the window open mode E_FAIL Failed to

retrieved the window open mode

Return type:: int

property window_open_mode: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property WindowOpenMode() As CatSecWindowOpenMode

Role:Retrieve section window open mode

Parameters:

oWindowOpenMode

Legal values:

catSecWindow_DefaultSize :Opens the sectioning window(s) with the

default size specified in the Tools->Options.

catSecWindow_TileVertically :Tiles the sectioning window(s)

vertically in the viewer

Returns:

S_OK Successfully retieved the window open mode E_FAIL Failed to

retrieved the window open mode

Returns:: enum cat_sec_window_open_mode
Return type:: int

pycatia.space_analyses_interfaces.sectioning_setting_att¶

Navigation

Related Topics