pycatia.cat_rsc_interfaces.rendering_environments

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_environments.RenderingEnvironments(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
RenderingEnvironments

A collection of all the Rendering Environments objects.
add(i_environment_type: int) → RenderingEnvironment

Note

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

Adds a new environment to the environments collection.

Parameters:

iEnvironmentType
The type of the environment to create choosen
among:

1 - For cubical environment
2 - For spherical environment
3 - For cylindrical environment
Parameters:

i_environment_type (int) –

Return type:

RenderingEnvironment

item(i_index: cat_variant) → RenderingEnvironment

Note

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

Returns an environment index in the environments
collection.

Parameters:

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

Returns:
The retrieved environment

Example:
The following example returns in MyEnvironment the sixth environment in a
environment collection.

Dim MyEnvironment As RenderingEnvironment
Set MyEnvironment = RenderingEnvironments.Item(6)
Parameters:

i_index (cat_variant) –

Return type:

RenderingEnvironment

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 environment from the environments 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 environments.of the collection
Return type:

None