pycatia.cat_rsc_interfaces.rendering_lights

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

Warning

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

class pycatia.cat_rsc_interfaces.rendering_lights.RenderingLights(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
RenderingLights

A collection of all the Rendering Lights objects.
add() → RenderingLight

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Add() As RenderingLight

Adds a new light to the lights collection.
Return type:

RenderingLight

item(i_index: cat_variant) → RenderingLight

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Item(CATVariant iIndex) As RenderingLight

Returns a rendering light index in the rendering light
collection.

Parameters:

iIndex
The index of the light to retrieve in the collection of lights.
Compared with other collections, you cannot use the name of the light as
argument.

Returns:
The retrieved light

Example:
The following example returns in MyLight the sixth light in a lights
collection.

Dim MyLight As RenderingLight
Set MyLight = RenderingLights.Item(6)
Parameters:

i_index (cat_variant) –

Return type:

RenderingLight

remove(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Remove(CATVariant iIndex)

Removes a light from the lights collection.
Parameters:

i_index (cat_variant) –

Return type:

None

remove_all() → None

Note

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

Removes all lights from the collection.
Return type:

None