pycatia.in_interfaces.visualization_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.in_interfaces.visualization_setting_att.VisualizationSettingAtt(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

VisualizationSettingAtt

The interface to access a CATIAVisualizationSettingAtt.

property accurate_picking_mode: bool

Note

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

o Property AccuratePickingMode() As boolean

Returns the AccuratePickingMode parameter.

Return type:

bool

property accurate_picking_window_size: int

Note

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

o Property AccuratePickingWindowSize() As long

Returns the AccuratePickingWindowSize parameter.

Return type:

int

property all_z_buffer_element_mode: bool

Note

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

o Property AllZBufferElementMode() As boolean

Returns the AllZBufferElementMode parameter.

Return type:

bool

property ambient_activation: int

Note

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

o Property AmbientActivation() As long

Returns the AmbientActivation parameter.

Return type:

int

property anti_aliasing_mode: bool

Note

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

o Property AntiAliasingMode() As boolean

Returns the AntiAliasingMode parameter.

Return type:

bool

property anti_aliasing_offset: float

Note

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

o Property AntiAliasingOffset() As double

Returns the AntiAliasingOffset parameter.

Return type:

float

property auxiliary_drill_viewer: bool

Note

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

o Property AuxiliaryDrillViewer() As boolean

Returns the AuxiliaryDrillViewer parameter.

Return type:

bool

property back_face_culling_mode: bool

Note

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

o Property BackFaceCullingMode() As boolean

Deprecated:

V5R16. Returns the BackFaceCullingMode parameter.

Return type:

bool

property border_edges_mode: bool

Note

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

o Property BorderEdgesMode() As boolean

Returns the BorderEdgesMode parameter.

Return type:

bool

property border_edges_thickness: int

Note

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

o Property BorderEdgesThickness() As long

Returns the BorderEdgesThickness parameter.

Return type:

int

property bounding_box_selection_mode: bool

Note

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

o Property BoundingBoxSelectionMode() As boolean

Returns the BoundingBoxSelectionMode parameter.

Return type:

bool

property color_background_mode: bool

Note

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

o Property ColorBackgroundMode() As boolean

Returns the ColorBackgroundMode parameter.

Return type:

bool

property default_diffuse_ambient_coefficient: float

Note

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

o Property DefaultDiffuseAmbientCoefficient() As double

Returns the AmbientActivation parameter.

Return type:

float

property default_shininess: float

Note

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

o Property DefaultShininess() As double

Returns the AmbientActivation parameter.

Return type:

float

property default_specular_coefficient: float

Note

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

o Property DefaultSpecularCoefficient() As double

Returns the AmbientActivation parameter.

Return type:

float

property display_current_scale: bool

Note

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

o Property DisplayCurrentScale() As boolean

Returns the SetStereoModeLock parameter.

Return type:

bool

property display_drill_list: bool

Note

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

o Property DisplayDrillList() As boolean

Returns the DisplayDrillList parameter.

Return type:

bool

property display_immersive_drill_viewer: bool

Note

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

o Property DisplayImmersiveDrillViewer() As boolean

Returns the DisplayImmersiveDrillViewer parameter.

Return type:

bool

property dynamic_cull: int

Note

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

o Property DynamicCull() As long

Returns the DynamicCull parameter.

Return type:

int

property dynamic_lod: float

Note

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

o Property DynamicLOD() As double

Returns the DynamicLOD parameter.

Return type:

float

property face_hl_drill: bool

Note

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

o Property FaceHLDrill() As boolean

Returns the FaceHLDrill parameter.

Return type:

bool

property fly_collision_mode: bool

Note

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

o Property FlyCollisionMode() As boolean

Returns the FlyCollisionMode parameter.

Return type:

bool

property fly_collision_sphere_radius: float

Note

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

o Property FlyCollisionSphereRadius() As double

Returns the FlyCollisionSphereRadius parameter.

Return type:

float

property fly_collision_type: int

Note

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

o Property FlyCollisionType() As long

Returns the FlyCollisionType parameter.

Return type:

int

property fly_sensitivity: int

Note

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

o Property FlySensitivity() As long

Returns the FlySensitivity parameter.

Return type:

int

property fly_speed: int

Note

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

o Property FlySpeed() As long

Returns the FlySpeed parameter.

Return type:

int

property fly_speed_mode: int

Note

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

o Property FlySpeedMode() As long

Returns the FlySpeedMode parameter.

Return type:

int

property follow_ground_altitude: float

Note

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

o Property FollowGroundAltitude() As double

Returns the FollowGroundAltitude parameter.

Return type:

float

property follow_ground_mode: bool

Note

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

o Property FollowGroundMode() As boolean

Returns the FollowGroundMode parameter.

Return type:

bool

property full_scene_anti_aliasing_mode: int

Note

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

o Property FullSceneAntiAliasingMode() As

CATFullSceneAntiAliasingMode

Returns the AntiAliasingMode parameter.

Returns:

enum cat_full_scene_anti_aliasing_mode

Return type:

int

get_accurate_picking_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 GetAccuratePickingModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the AccuratePickingMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetAccuratePickingWindowSizeInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the AccuratePickingWindowSize setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_all_z_buffer_element_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 GetAllZBufferElementModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the AllZBufferElementMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetAmbientActivationInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the AmbientActivation setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_anti_aliasing_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 GetAntiAliasingModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the AntiAliasingMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetAntiAliasingOffsetInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the AntiAliasingOffset setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetAuxiliaryDrillViewerInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the AuxiliaryDrillViewer setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_back_face_culling_mode() → int

Note

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

o Func GetBackFaceCullingMode() As CATBackFaceCullingMode

Retrieves the BackFaceCullingMode parameter.

Parameters:

oBackFaceCullingMode

Value of the back face culling mode setting option. The retrieved

value can be one of the four possible values defined by the

CATBackFaceCullingMode enumeration.

Returns:

An HRESULT.

Legal values:

S_OK

if the operation succeeded.

E_FAIL

if the operation failed.

Returns:

enum cat_back_face_culling_mode

Return type:

int

get_back_face_culling_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 GetBackFaceCullingModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the BackFaceCullingMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_background_rgb(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 GetBackgroundRGB(long ioR,

long ioG,

long ioB)

Returns the BackgroundRGB parameter.

Parameters:

• io_r (int) –

• io_g (int) –

• io_b (int) –

Return type:

None

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

Note

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

o Func GetBackgroundRGBInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the BackgroundRGB setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_border_edges_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 GetBorderEdgesModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the BorderEdgesMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_border_edges_rgb(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 GetBorderEdgesRGB(long ioR,

long ioG,

long ioB)

Returns the BorderEdgesRGB parameter.

Parameters:

• io_r (int) –

• io_g (int) –

• io_b (int) –

Return type:

None

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

Note

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

o Func GetBorderEdgesRGBInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the BorderEdgesRGB setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetBorderEdgesThicknessInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the BorderEdgesThickness setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_bounding_box_selection_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 GetBoundingBoxSelectionModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the BoundingBoxSelectionMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_color_background_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 GetColorBackgroundModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ColorBackgroundMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDefaultDiffuseAmbientCoefficientInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the DefaultDiffuseAmbientCoefficient setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDefaultShininessInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the DefaultShininess setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDefaultSpecularCoefficientInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the DefaultSpecularCoefficient setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDisplayCurrentScaleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the SetStereoModeLock setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDisplayDrillListInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the DisplayDrillList setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDisplayImmersiveDrillViewerInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the DisplayImmersiveDrillViewer setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDynamicCullInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the DynamicCull setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetDynamicLODInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the DynamicLOD setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetFaceHLDrillInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the FaceHLDrill setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_fly_collision_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 GetFlyCollisionModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the FlyCollisionMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetFlyCollisionSphereRadiusInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the FlyCollisionSphereRadius setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_fly_collision_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 GetFlyCollisionTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the FlyCollisionType setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetFlySensitivityInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the FlySensitivity setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetFlySpeedInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the FlySpeed setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_fly_speed_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 GetFlySpeedModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the FlySpeedMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetFollowGroundAltitudeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the FollowGroundAltitude setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_follow_ground_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 GetFollowGroundModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the FollowGroundMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_full_scene_anti_aliasing_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 GetFullSceneAntiAliasingModeInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the AntiAliasingMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetGravityAxisInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the GravityAxis setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetGravityInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the Gravity setting parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_halo_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 GetHaloModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the HaloMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_handles_rgb(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 GetHandlesRGB(long ioR,

long ioG,

long ioB)

Returns the HandlesRGB parameter.

Parameters:

• io_r (int) –

• io_g (int) –

• io_b (int) –

Return type:

None

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

Note

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

o Func GetHandlesRGBInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the HandlesRGB setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_isopar_generation_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 GetIsoparGenerationModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the IsoparGenerationMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetKeyboardRotationAngleValueInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the KeyboardRotationAngleValue setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_light_viewer_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 GetLightViewerModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the LightViewerMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_lineic_cgr_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 GetLineicCgrModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the LineicCgrMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetMaxSelectionMoveInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the MaxSelectionMove setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_minimum_fps_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 GetMinimumFPSModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the MinimumFPSMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_minimum_space_fps_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 GetMinimumSpaceFPSModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the MinimumSpaceFPSMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetMouseDoubleClicDelayInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the MouseDoubleClicDelay setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetMouseSpeedValueInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the MouseSpeedValue setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetNbIsoparsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the NbIsopars setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_no_show_background_rgb(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 GetNoShowBackgroundRGB(long ioR,

long ioG,

long ioB)

Retrieves the No Show Background Color setting attribute

value.

Role: The No Show Background Color setting attribute manages the

backgraound color of no show space

Parameters:

ioR,

ioG, ioB [inout] The Red, Green, Blue components of the No Show

Background Color setting attribute value

Returns:

S_OK if the No Show Background Color setting attribute value is

successfully retrieved, and E_FAIL otherwise

Parameters:

• io_r (int) –

• io_g (int) –

• io_b (int) –

Return type:

None

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

Note

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

o Func GetNoShowBackgroundRGBInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves the No Show Background Color setting attribute

information.

Parameters:

ioAdminLevel,

ioLocked [inout] and oModified [out] The No Show Background Color

setting attribute information

Returns:

S_OK if the No Show Background Color setting attribute information is

successfully retrieved, and E_FAIL otherwise

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_no_z_buffer_selection_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 GetNoZBufferSelectionModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the NoZBufferSelectionMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetNumberOfMinimumFPSInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the NumberOfMinimumFPS setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetNumberOfMinimumSpaceFPSInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the NumberOfMinimumSpaceFPS setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_occlusion_culling_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 GetOcclusionCullingModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OcclusionCullingMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetOpaqueFacesInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the SetStereoModeLock setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetOtherSelectionTimeoutActivityInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OtherSelectionTimeoutActivity setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetOtherSelectionTimeoutInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the OtherSelectionTimeout setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetPickingWindowSizeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the PickingWindowSize setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_pre_selection_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 GetPreSelectionModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the PreSelectionMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetPreselectedElementLinetypeInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the PreselectedElementLinetype setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_preselected_element_rgb(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 GetPreselectedElementRGB(long ioR,

long ioG,

long ioB)

Returns the PreselectedElementRGB parameter.

Parameters:

• io_r (int) –

• io_g (int) –

• io_b (int) –

Return type:

None

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

Note

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

o Func GetPreselectedElementRGBInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the PreselectedElementRGB setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rotation_sphere_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 GetRotationSphereModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the RotationSphereMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_selected_edge_rgb(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 GetSelectedEdgeRGB(long ioR,

long ioG,

long ioB)

Returns the SelectedEdgeRGB parameter.

Parameters:

• io_r (int) –

• io_g (int) –

• io_b (int) –

Return type:

None

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

Note

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

o Func GetSelectedEdgeRGBInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the SelectedEdgeRGB setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_selected_element_rgb(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 GetSelectedElementRGB(long ioR,

long ioG,

long ioB)

Returns the SelectedElementRGB parameter.

Parameters:

• io_r (int) –

• io_g (int) –

• io_b (int) –

Return type:

None

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

Note

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

o Func GetSelectedElementRGBInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the SelectedElementRGB setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_shader_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 GetShaderModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ShaderMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetStaticCullInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the StaticCull setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetStaticLODInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the StaticLOD setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_stereo_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 GetStereoModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the StereoMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_transparency_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 GetTransparencyModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the TransparencyMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_two_side_lighting_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 GetTwoSideLightingModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the TwoSideLightingMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_under_intensified_rgb(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 GetUnderIntensifiedRGB(long ioR,

long ioG,

long ioB)

Returns the UnderIntensifiedRGB parameter.

Parameters:

• io_r (int) –

• io_g (int) –

• io_b (int) –

Return type:

None

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

Note

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

o Func GetUnderIntensifiedRGBInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the UnderIntensifiedRGB setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_update_needed_rgb(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 GetUpdateNeededRGB(long ioR,

long ioG,

long ioB)

Returns the UpdateNeededRGB parameter.

Parameters:

• io_r (int) –

• io_g (int) –

• io_b (int) –

Return type:

None

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

Note

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

o Func GetUpdateNeededRGBInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the UpdateNeededRGB setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_viewpoint_animation_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 GetViewpointAnimationModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ViewpointAnimationMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_viz2_d_accuracy_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 GetViz2DAccuracyModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the 2DAccuracyMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetViz2DFixedAccuracyInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the 2DFixedAccuracy setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetViz2DProportionnalAccuracyInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the 2DProportionnalAccuracy setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_viz3_d_accuracy_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 GetViz3DAccuracyModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the Viz3DAccuracyMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetViz3DCurveAccuracyInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the 3DCurveAccuracy setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetViz3DFixedAccuracyInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the 3DFixedAccuracy setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetViz3DProportionnalAccuracyInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the Viz3DProportionnalAccuracy setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

property gravity: bool

Note

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

o Property Gravity() As boolean

Returns the Gravity parameter.

Return type:

bool

property gravity_axis: int

Note

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

o Property GravityAxis() As long

Returns the GravityAxis parameter.

Return type:

int

property halo_mode: bool

Note

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

o Property HaloMode() As boolean

Returns the HaloMode parameter.

Return type:

bool

property isopar_generation_mode: bool

Note

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

o Property IsoparGenerationMode() As boolean

Returns the IsoparGenerationMode parameter.

Return type:

bool

property keyboard_rotation_angle_value: int

Note

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

o Property KeyboardRotationAngleValue() As long

Retrieves the angle value for rotations operated through key combinations.

Return type:

int

property light_viewer_mode: bool

Note

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

o Property LightViewerMode() As boolean

Returns the LightViewerMode parameter.

Return type:

bool

property lineic_cgr_mode: bool

Note

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

o Property LineicCgrMode() As boolean

Returns the LineicCgrMode parameter.

Return type:

bool

property max_selection_move: int

Note

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

o Property MaxSelectionMove() As long

Returns the MaxSelectionMove parameter.

Return type:

int

property minimum_fps_mode: bool

Note

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

o Property MinimumFPSMode() As boolean

Returns the MinimumFPSMode parameter.

Return type:

bool

property minimum_space_fps_mode: bool

Note

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

o Property MinimumSpaceFPSMode() As boolean

Returns the MinimumSpaceFPSMode parameter.

Return type:

bool

property mouse_double_clic_delay: int

Note

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

o Property MouseDoubleClicDelay() As long

Returns the MouseDoubleClicDelay parameter.

Return type:

int

property mouse_speed_value: int

Note

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

o Property MouseSpeedValue() As long

Returns the MouseSpeedValue parameter.

Return type:

int

property nb_isopars: int

Note

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

o Property NbIsopars() As long

Returns the NbIsopars parameter.

Return type:

int

property no_z_buffer_selection_mode: bool

Note

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

o Property NoZBufferSelectionMode() As boolean

Returns the NoZBufferSelectionMode parameter.

Return type:

bool

property number_of_minimum_fps: int

Note

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

o Property NumberOfMinimumFPS() As long

Returns the NumberOfMinimumFPS parameter.

Return type:

int

property number_of_minimum_space_fps: int

Note

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

o Property NumberOfMinimumSpaceFPS() As long

Returns the NumberOfMinimumSpaceFPS parameter.

Return type:

int

property occlusion_culling_mode: bool

Note

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

o Property OcclusionCullingMode() As boolean

Returns the OcclusionCullingMode parameter.

Return type:

bool

property opaque_faces: bool

Note

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

o Property OpaqueFaces() As boolean

Returns the SetStereoModeLock parameter.

Return type:

bool

property other_selection_timeout: float

Note

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

o Property OtherSelectionTimeout() As double

Returns the OtherSelectionTimeout parameter.

Return type:

float

property other_selection_timeout_activity: bool

Note

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

o Property OtherSelectionTimeoutActivity() As boolean

Returns the OtherSelectionTimeoutActivity parameter.

Return type:

bool

property picking_window_size: int

Note

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

o Property PickingWindowSize() As long

Returns the PickingWindowSize parameter.

Return type:

int

property pre_selection_mode: bool

Note

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

o Property PreSelectionMode() As boolean

Returns the PreSelectionMode parameter.

Return type:

bool

property preselected_element_linetype: int

Note

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

o Property PreselectedElementLinetype() As long

Returns the PreselectedElementLinetype parameter.

Return type:

int

put_back_face_culling_mode(i_back_face_culling_mode: int) → None

Note

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

o Sub PutBackFaceCullingMode(CATBackFaceCullingMode

iBackFaceCullingMode)

Sets the BackFaceCullingMode attribute.

Parameters:

iBackFaceCullingMode

Value of the back face culling mode setting option. The value to

set can be one of the four possible values defined by the

CATBackFaceCullingMode enumeration.

Returns:

An HRESULT.

Legal values:

S_OK

if the operation succeeded.

E_FAIL

if the operation failed.

Parameters:

i_back_face_culling_mode (int) – enum cat_back_face_culling_mode

Return type:

None

property rotation_sphere_mode: bool

Note

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

o Property RotationSphereMode() As boolean

Returns the RotationSphereMode parameter.

Return type:

bool

set_accurate_picking_mode_lock(i_locked: bool) → None

Note

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

o Sub SetAccuratePickingModeLock(boolean iLocked)

Locks or unlocks the AccuratePickingMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_accurate_picking_window_size_lock(i_locked: bool) → None

Note

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

o Sub SetAccuratePickingWindowSizeLock(boolean iLocked)

Locks or unlocks the AccuratePickingWindowSize setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_all_z_buffer_element_mode_lock(i_locked: bool) → None

Note

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

o Sub SetAllZBufferElementModeLock(boolean iLocked)

Locks or unlocks the AllZBufferElementMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_ambient_activation_lock(i_locked: bool) → None

Note

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

o Sub SetAmbientActivationLock(boolean iLocked)

Locks or unlocks the AmbientActivation setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_anti_aliasing_mode_lock(i_locked: bool) → None

Note

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

o Sub SetAntiAliasingModeLock(boolean iLocked)

Locks or unlocks the AntiAliasingMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_anti_aliasing_offset_lock(i_locked: bool) → None

Note

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

o Sub SetAntiAliasingOffsetLock(boolean iLocked)

Locks or unlocks the AntiAliasingOffset setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_auxiliary_drill_viewer_lock(i_locked: bool) → None

Note

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

o Sub SetAuxiliaryDrillViewerLock(boolean iLocked)

Locks or unlocks the AuxiliaryDrillViewer setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_back_face_culling_mode_lock(i_locked: bool) → None

Note

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

o Sub SetBackFaceCullingModeLock(boolean iLocked)

Locks or unlocks the BackFaceCullingMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_background_rgb(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 SetBackgroundRGB(long iR,

long iG,

long iB)

Sets the BackgroundRGB parameter.

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_background_rgb_lock(i_locked: bool) → None

Note

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

o Sub SetBackgroundRGBLock(boolean iLocked)

Locks or unlocks the BackgroundRGB setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_border_edges_mode_lock(i_locked: bool) → None

Note

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

o Sub SetBorderEdgesModeLock(boolean iLocked)

Locks or unlocks the BorderEdgesMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_border_edges_rgb(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 SetBorderEdgesRGB(long iR,

long iG,

long iB)

Sets the BorderEdgesRGB parameter.

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_border_edges_rgb_lock(i_locked: bool) → None

Note

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

o Sub SetBorderEdgesRGBLock(boolean iLocked)

Locks or unlocks the BorderEdgesRGB setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_border_edges_thickness_lock(i_locked: bool) → None

Note

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

o Sub SetBorderEdgesThicknessLock(boolean iLocked)

Locks or unlocks the BorderEdgesThickness setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_bounding_box_selection_mode_lock(i_locked: bool) → None

Note

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

o Sub SetBoundingBoxSelectionModeLock(boolean iLocked)

Locks or unlocks the BoundingBoxSelectionMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_color_background_mode_lock(i_locked: bool) → None

Note

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

o Sub SetColorBackgroundModeLock(boolean iLocked)

Locks or unlocks the ColorBackgroundMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_default_diffuse_ambient_coefficient_lock(i_locked: bool) → None

Note

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

o Sub SetDefaultDiffuseAmbientCoefficientLock(boolean

iLocked)

Locks or unlocks the DefaultDiffuseAmbientCoefficient setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_default_shininess_lock(i_locked: bool) → None

Note

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

o Sub SetDefaultShininessLock(boolean iLocked)

Locks or unlocks the DefaultShininess setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_default_specular_coefficient_lock(i_locked: bool) → None

Note

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

o Sub SetDefaultSpecularCoefficientLock(boolean iLocked)

Locks or unlocks the DefaultSpecularCoefficient setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_display_current_scale_lock(i_locked: bool) → None

Note

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

o Sub SetDisplayCurrentScaleLock(boolean iLocked)

Locks or unlocks the SetStereoModeLock setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_display_drill_list_lock(i_locked: bool) → None

Note

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

o Sub SetDisplayDrillListLock(boolean iLocked)

Locks or unlocks the DisplayDrillList setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_display_immersive_drill_viewer_lock(i_locked: bool) → None

Note

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

o Sub SetDisplayImmersiveDrillViewerLock(boolean iLocked)

Locks or unlocks the DisplayImmersiveDrillViewer setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_dynamic_cull_lock(i_locked: bool) → None

Note

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

o Sub SetDynamicCullLock(boolean iLocked)

Locks or unlocks the DynamicCull setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_dynamic_lod_lock(i_locked: bool) → None

Note

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

o Sub SetDynamicLODLock(boolean iLocked)

Locks or unlocks the DynamicLOD setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_face_hl_drill_lock(i_locked: bool) → None

Note

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

o Sub SetFaceHLDrillLock(boolean iLocked)

Locks or unlocks the FaceHLDrill setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_fly_collision_mode_lock(i_locked: bool) → None

Note

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

o Sub SetFlyCollisionModeLock(boolean iLocked)

Locks or unlocks the FlyCollisionMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_fly_collision_sphere_radius_lock(i_locked: bool) → None

Note

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

o Sub SetFlyCollisionSphereRadiusLock(boolean iLocked)

Locks or unlocks the FlyCollisionSphereRadius setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_fly_collision_type_lock(i_locked: bool) → None

Note

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

o Sub SetFlyCollisionTypeLock(boolean iLocked)

Locks or unlocks the FlyCollisionType setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_fly_sensitivity_lock(i_locked: bool) → None

Note

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

o Sub SetFlySensitivityLock(boolean iLocked)

Locks or unlocks the FlySensitivity setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_fly_speed_lock(i_locked: bool) → None

Note

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

o Sub SetFlySpeedLock(boolean iLocked)

Locks or unlocks the FlySpeed setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_fly_speed_mode_lock(i_locked: bool) → None

Note

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

o Sub SetFlySpeedModeLock(boolean iLocked)

Locks or unlocks the FlySpeedMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_follow_ground_altitude_lock(i_locked: bool) → None

Note

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

o Sub SetFollowGroundAltitudeLock(boolean iLocked)

Locks or unlocks the FollowGroundAltitude setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_follow_ground_mode_lock(i_locked: bool) → None

Note

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

o Sub SetFollowGroundModeLock(boolean iLocked)

Locks or unlocks the FollowGroundMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_full_scene_anti_aliasing_mode_lock(i_locked: bool) → None

Note

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

o Sub SetFullSceneAntiAliasingModeLock(boolean iLocked)

Locks or unlocks the AntiAliasingMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_gravity_axis_lock(i_locked: bool) → None

Note

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

o Sub SetGravityAxisLock(boolean iLocked)

Locks or unlocks the GravityAxis setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_gravity_lock(i_locked: bool) → None

Note

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

o Sub SetGravityLock(boolean iLocked)

Locks or unlocks the Gravity setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_halo_mode_lock(i_locked: bool) → None

Note

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

o Sub SetHaloModeLock(boolean iLocked)

Locks or unlocks the HaloMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_handles_rgb(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 SetHandlesRGB(long iR,

long iG,

long iB)

Sets the HandlesRGB parameter.

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_handles_rgb_lock(i_locked: bool) → None

Note

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

o Sub SetHandlesRGBLock(boolean iLocked)

Locks or unlocks the HandlesRGB setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_isopar_generation_mode_lock(i_locked: bool) → None

Note

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

o Sub SetIsoparGenerationModeLock(boolean iLocked)

Locks or unlocks the IsoparGenerationMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_keyboard_rotation_angle_value_lock(i_locked: bool) → None

Note

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

o Sub SetKeyboardRotationAngleValueLock(boolean iLocked)

Locks or unlocks the KeyboardRotationAngleValue setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_light_viewer_mode_lock(i_locked: bool) → None

Note

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

o Sub SetLightViewerModeLock(boolean iLocked)

Locks or unlocks the LightViewerMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_lineic_cgr_mode_lock(i_locked: bool) → None

Note

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

o Sub SetLineicCgrModeLock(boolean iLocked)

Locks or unlocks the v setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_max_selection_move_lock(i_locked: bool) → None

Note

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

o Sub SetMaxSelectionMoveLock(boolean iLocked)

Locks or unlocks the MaxSelectionMove setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_minimum_fps_mode_lock(i_locked: bool) → None

Note

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

o Sub SetMinimumFPSModeLock(boolean iLocked)

Locks or unlocks the MinimumFPSMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_minimum_space_fps_mode_lock(i_locked: bool) → None

Note

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

o Sub SetMinimumSpaceFPSModeLock(boolean iLocked)

Locks or unlocks the MinimumSpaceFPSMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_mouse_double_clic_delay_lock(i_locked: bool) → None

Note

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

o Sub SetMouseDoubleClicDelayLock(boolean iLocked)

Locks or unlocks the MouseDoubleClicDelay setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_mouse_speed_value_lock(i_locked: bool) → None

Note

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

o Sub SetMouseSpeedValueLock(boolean iLocked)

Locks or unlocks the MouseSpeedValue setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_nb_isopars_lock(i_locked: bool) → None

Note

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

o Sub SetNbIsoparsLock(boolean iLocked)

Locks or unlocks the NbIsopars setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_no_show_background_rgb(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 SetNoShowBackgroundRGB(long iR,

long iG,

long iB)

Sets the No Show Background Color setting attribute value.

Role: The No Show Background Color setting attribute manages the

backgraound color of no show space

Parameters:

iR,

iG, iB [in] The Red, Green, Blue components of the No Show

Background Color setting attribute value

Legal values: between 0 and 255

Returns:

S_OK if the No Show Background Color setting attribute value is

successfully set, and E_FAIL otherwise

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_no_show_background_rgb_lock(i_locked: bool) → None

Note

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

o Sub SetNoShowBackgroundRGBLock(boolean iLocked)

Locks or unlocks the No Show Background Color setting

attribute.

Role: Locks or unlocks the No Show Background Color setting attribute if

the operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

[in] A flag to indicate whether the No Show Background Color

setting attribute should be locked.

Legal values:

TRUE to lock

FALSE to unlock

Returns:

S_OK if the No Show Background Color setting attribute is successfully

locked or unlocked, and E_FAIL otherwise

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_no_z_buffer_selection_mode_lock(i_locked: bool) → None

Note

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

o Sub SetNoZBufferSelectionModeLock(boolean iLocked)

Locks or unlocks the NoZBufferSelectionMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_number_of_minimum_fps_lock(i_locked: bool) → None

Note

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

o Sub SetNumberOfMinimumFPSLock(boolean iLocked)

Locks or unlocks the NumberOfMinimumFPS setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_number_of_minimum_space_fps_lock(i_locked: bool) → None

Note

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

o Sub SetNumberOfMinimumSpaceFPSLock(boolean iLocked)

Locks or unlocks the NumberOfMinimumSpaceFPS setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_occlusion_culling_mode_lock(i_locked: bool) → None

Note

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

o Sub SetOcclusionCullingModeLock(boolean iLocked)

Locks or unlocks the OcclusionCullingMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_opaque_faces_lock(i_locked: bool) → None

Note

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

o Sub SetOpaqueFacesLock(boolean iLocked)

Locks or unlocks the SetStereoModeLock setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_other_selection_timeout_activity_lock(i_locked: bool) → None

Note

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

o Sub SetOtherSelectionTimeoutActivityLock(boolean iLocked)

Locks or unlocks the OtherSelectionTimeoutActivity setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_other_selection_timeout_lock(i_locked: bool) → None

Note

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

o Sub SetOtherSelectionTimeoutLock(boolean iLocked)

Locks or unlocks the OtherSelectionTimeout setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_picking_window_size_lock(i_locked: bool) → None

Note

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

o Sub SetPickingWindowSizeLock(boolean iLocked)

Locks or unlocks the PickingWindowSize setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_pre_selection_mode_lock(i_locked: bool) → None

Note

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

o Sub SetPreSelectionModeLock(boolean iLocked)

Locks or unlocks the PreSelectionMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_preselected_element_linetype_lock(i_locked: bool) → None

Note

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

o Sub SetPreselectedElementLinetypeLock(boolean iLocked)

Locks or unlocks the PreselectedElementLinetype setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_preselected_element_rgb(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 SetPreselectedElementRGB(long iR,

long iG,

long iB)

Sets the PreselectedElementRGB parameter.

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_preselected_element_rgb_lock(i_locked: bool) → None

Note

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

o Sub SetPreselectedElementRGBLock(boolean iLocked)

Locks or unlocks the PreselectedElementRGB setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_rotation_sphere_mode_lock(i_locked: bool) → None

Note

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

o Sub SetRotationSphereModeLock(boolean iLocked)

Locks or unlocks the RotationSphereMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_selected_edge_rgb(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 SetSelectedEdgeRGB(long iR,

long iG,

long iB)

Sets the SelectedEdgeRGB parameter.

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_selected_edge_rgb_lock(i_locked: bool) → None

Note

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

o Sub SetSelectedEdgeRGBLock(boolean iLocked)

Locks or unlocks the SelectedEdgeRGB setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_selected_element_rgb(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 SetSelectedElementRGB(long iR,

long iG,

long iB)

Sets the SelectedElementRGB parameter.

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_selected_element_rgb_lock(i_locked: bool) → None

Note

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

o Sub SetSelectedElementRGBLock(boolean iLocked)

Locks or unlocks the SelectedElementRGB setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_shader_mode_lock(i_locked: bool) → None

Note

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

o Sub SetShaderModeLock(boolean iLocked)

Locks or unlocks the ShaderMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_static_cull_lock(i_locked: bool) → None

Note

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

o Sub SetStaticCullLock(boolean iLocked)

Locks or unlocks the StaticCull setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_static_lod_lock(i_locked: bool) → None

Note

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

o Sub SetStaticLODLock(boolean iLocked)

Locks or unlocks the StaticLOD setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_stereo_mode_lock(i_locked: bool) → None

Note

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

o Sub SetStereoModeLock(boolean iLocked)

Locks or unlocks the StereoMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_transparency_mode_lock(i_locked: bool) → None

Note

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

o Sub SetTransparencyModeLock(boolean iLocked)

Locks or unlocks the TransparencyMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_two_side_lighting_mode_lock(i_locked: bool) → None

Note

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

o Sub SetTwoSideLightingModeLock(boolean iLocked)

Locks or unlocks the TwoSideLightingMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_under_intensified_rgb(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 SetUnderIntensifiedRGB(long iR,

long iG,

long iB)

Sets the UnderIntensifiedRGB parameter.

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_under_intensified_rgb_lock(i_locked: bool) → None

Note

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

o Sub SetUnderIntensifiedRGBLock(boolean iLocked)

Locks or unlocks the UnderIntensifiedRGB setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_update_needed_rgb(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 SetUpdateNeededRGB(long iR,

long iG,

long iB)

Sets the UpdateNeededRGB parameter.

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_update_needed_rgb_lock(i_locked: bool) → None

Note

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

o Sub SetUpdateNeededRGBLock(boolean iLocked)

Locks or unlocks the UpdateNeededRGB setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_viewpoint_animation_mode_lock(i_locked: bool) → None

Note

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

o Sub SetViewpointAnimationModeLock(boolean iLocked)

Locks or unlocks the ViewpointAnimationMode setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_viz2_d_accuracy_mode_lock(i_locked: bool) → None

Note

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

o Sub SetViz2DAccuracyModeLock(boolean iLocked)

Locks or unlocks the 2DAccuracyMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_viz2_d_fixed_accuracy_lock(i_locked: bool) → None

Note

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

o Sub SetViz2DFixedAccuracyLock(boolean iLocked)

Locks or unlocks the 2DFixedAccuracy setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_viz2_d_proportionnal_accuracy_lock(i_locked: bool) → None

Note

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

o Sub SetViz2DProportionnalAccuracyLock(boolean iLocked)

Locks or unlocks the 2DProportionnalAccuracy setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_viz3_d_accuracy_mode_lock(i_locked: bool) → None

Note

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

o Sub SetViz3DAccuracyModeLock(boolean iLocked)

Locks or unlocks the Viz3DAccuracyMode setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_viz3_d_curve_accuracy_lock(i_locked: bool) → None

Note

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

o Sub SetViz3DCurveAccuracyLock(boolean iLocked)

Locks or unlocks the 3DCurveAccuracy setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_viz3_d_fixed_accuracy_lock(i_locked: bool) → None

Note

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

o Sub SetViz3DFixedAccuracyLock(boolean iLocked)

Locks or unlocks the 3DFixedAccuracy setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_viz3_d_proportionnal_accuracy_lock(i_locked: bool) → None

Note

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

o Sub SetViz3DProportionnalAccuracyLock(boolean iLocked)

Locks or unlocks the Viz3DProportionnalAccuracy setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

property shader_mode: bool

Note

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

o Property ShaderMode() As boolean

Returns the ShaderMode parameter.

Return type:

bool

property static_cull: int

Note

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

o Property StaticCull() As long

Returns the StaticCull parameter.

Return type:

int

property static_lod: float

Note

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

o Property StaticLOD() As double

Returns the StaticLOD parameter.

Return type:

float

property stereo_mode: bool

Note

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

o Property StereoMode() As boolean

Returns the StereoMode parameter.

Return type:

bool

property transparency_mode: bool

Note

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

o Property TransparencyMode() As boolean

Returns the TransparencyMode parameter.

Return type:

bool

property two_side_lighting_mode: bool

Note

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

o Property TwoSideLightingMode() As boolean

Returns the TwoSideLightingMode parameter.

Return type:

bool

property viewpoint_animation_mode: bool

Note

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

o Property ViewpointAnimationMode() As boolean

Returns the ViewpointAnimationMode parameter.

Return type:

bool

property viz2_d_accuracy_mode: bool

Note

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

o Property Viz2DAccuracyMode() As boolean

Returns the 2DAccuracyMode parameter.

Return type:

bool

property viz2_d_fixed_accuracy: float

Note

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

o Property Viz2DFixedAccuracy() As double

Returns the 2DFixedAccuracy parameter.

Return type:

float

property viz2_d_proportionnal_accuracy: float

Note

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

o Property Viz2DProportionnalAccuracy() As double

Returns the 2DProportionnalAccuracy parameter.

Return type:

float

property viz3_d_accuracy_mode: bool

Note

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

o Property Viz3DAccuracyMode() As boolean

Returns the Viz3DAccuracyMode parameter.

Return type:

bool

property viz3_d_curve_accuracy: float

Note

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

o Property Viz3DCurveAccuracy() As double

Returns the 3DCurveAccuracy parameter.

Return type:

float

property viz3_d_fixed_accuracy: float

Note

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

o Property Viz3DFixedAccuracy() As double

Returns the 3DFixedAccuracy parameter.

Return type:

float

property viz3_d_proportionnal_accuracy: float

Note

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

o Property Viz3DProportionnalAccuracy() As double

Returns the Viz3DProportionnalAccuracy parameter.

Return type:

float