pycatia.osm_interfaces.scenes

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.osm_interfaces.scenes.Scenes(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
Scenes

A collection of scenes contained in a given ProductDocument.
add_copy_scene(i_name: str, i_reference_scene: Scene) → Scene

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddCopyScene(CATBSTR iName,
Scene iReferenceScene) As Scene

Creates a scene from another and adds it to the Scenes
collection.

Parameters:

iName
The name of the scene
iReferenceScene
The scene to be copied

Returns:
The created scene
Example:

This example creates the Engine scene from the SpareWheel
scene
and adds the scene to the ToolKits collection.

Dim Engine As Scene
Set Engine = ToolKits.AddNewScene(“Engine”, SpareWheel)
Parameters:

  • i_name (str) –

  • i_reference_scene (Scene) –

Return type:

Scene

add_new_scene(i_name: str, i_reference_product: Product) → Scene

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddNewScene(CATBSTR iName,
Product iReferenceProduct) As Scene

Creates a scene from a product and adds it to the Scenes
collection.

Parameters:

iName
The name of the scene
iReferenceProduct
The product used as reference

Returns:
The created scene
Example:

This example creates the SpareWheel scene from the reference
product
FrontRightWheel and adds the scene to the ToolKits
collection.

Dim SpareWheel As Scene
Set SpareWheel = ToolKits.AddNewScene(“SpareWheel”, FrontRightWheel)
Parameters:

  • i_name (str) –

  • i_reference_product (Product) –

Return type:

Scene

remove(i_scene: Scene) → None

Note

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

Removes a scene from the Scenes collection.

Parameters:

iScene
The scene to remove.

Example:

This example removes the Engine scene from the ToolKits
collection.

ToolKits.Remove Engine
Parameters:

i_scene (Scene) –

Return type:

None