pycatia.structure_interfaces.colour_std_object_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.structure_interfaces.colour_std_object_setting_att.ColourStdObjectSettingAtt(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
System.SettingController
ColorSTDObjectSettingAtt

The interface to access a CATIAColorSTDObjectSettingAtt.
get_plate_colour(o_plate_colour_r: int, o_plate_colour_g: int, o_plate_colour_b: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetPlateColor(long oPlateColorR,
long oPlateColorG,
long oPlateColorB)

Returns or sets the PlateColor parameter.

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

  • o_plate_colour_r (int) –

  • o_plate_colour_g (int) –

  • o_plate_colour_b (int) –

Return type:

None

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPlateColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the PlateColor
parameter.
Role:Retrieves the state of the PlateColor 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_shape_colour(o_shape_colour_r: int, o_shape_colour_g: int, o_shape_colour_b: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetShapeColor(long oShapeColorR,
long oShapeColorG,
long oShapeColorB)

Returns or sets the ShapeColor parameter.

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

  • o_shape_colour_r (int) –

  • o_shape_colour_g (int) –

  • o_shape_colour_b (int) –

Return type:

None

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetShapeColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ShapeColor
parameter.
Role:Retrieves the state of the ShapeColor 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

set_plate_colour(i_plate_colour_r: int, i_plate_colour_g: int, i_plate_colour_b: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetPlateColor(long iPlateColorR,
long iPlateColorG,
long iPlateColorB)
Parameters:

  • i_plate_colour_r (int) –

  • i_plate_colour_g (int) –

  • i_plate_colour_b (int) –

Return type:

None

set_plate_colour_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetPlateColorLock(boolean iLocked)

Locks or unlocks the PlateColor parameter.
Role:Locks or unlocks the PlateColor 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_shape_colour(i_shape_colour_r: int, i_shape_colour_g: int, i_shape_colour_b: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetShapeColor(long iShapeColorR,
long iShapeColorG,
long iShapeColorB)
Parameters:

  • i_shape_colour_r (int) –

  • i_shape_colour_g (int) –

  • i_shape_colour_b (int) –

Return type:

None

set_shape_colour_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetShapeColorLock(boolean iLocked)

Locks or unlocks the ShapeColor parameter.
Role:Locks or unlocks the ShapeColor 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