pycatia.osm_interfaces.product_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.product_scenes.ProductScenes(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
ProductScenes

A collection of ProductScenes contained in a given
ProductDocument.
add_product_scene_full(i_name: str, i_reference_products: tuple) → ProductScene

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddProductSceneFull(CATBSTR iName,
CATSafeArrayVariant iReferenceProducts) As ProductScene

Creates a new FULL scene from a set of products and adds it to the
ProductScenes collection.

Parameters:

iName
The name of the new scene
iReferenceProducts
Products used as root nodes of the new scene

Returns:
The created new full scene
Example:

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

Dim SpareWheel As ProductScene
Set SpareWheel = ToolKits.AddProductSceneFull(“SpareWheel”, FrontRightWheel)
Parameters:

  • i_name (str) –

  • i_reference_products (tuple) –

Return type:

ProductScene

add_product_scene_partial(i_name: str, i_reference_products: tuple) → ProductScene

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddProductScenePartial(CATBSTR iName,
CATSafeArrayVariant iReferenceProducts) As ProductScene

Creates a new DELTA scene from a set of products and adds it to the
ProductScenes collection.

Parameters:

iName
The name of the new scene
iReferenceProducts
Products used as root nodes of the new scene

Returns:
The created new delta scene
Example:

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

Dim SpareWheel As ProductScene
Set SpareWheel = ToolKits.AddProductScenePartial(“SpareWheel”, FrontRightWheel)
Parameters:

  • i_name (str) –

  • i_reference_products (tuple) –

Return type:

ProductScene

item(i_index: cat_variant) → ProductScene

Note

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

Returns a scene using its index or its name from the ProductScenes
collection.

Parameters:

iIndex
The index or the name of the ProductScene to retrieve from the
collection of ProductScenes. As a numerics, this index is the rank of the
ProductScene in the collection. The index of the first ProductScene in the
collection is 1, and the index of the last ProductScene is Count. As a string,
it is the name you assigned to the ProductScene.

Returns:
The retrieved ProductScene.
Example:

This example retrieves in ThisProductScene the ninth
ProductScene,
and in ThatProductScene the ProductScene named
ProductScene3 from the TheProductScenes collection.

Dim ThisProductScene As ProductScene
Set ThisProductScene = TheProductScenes.Item(9)
Dim ThatProductScene As ProductScene
Set ThatProductScene = TheProductScenes.Item(“ProductScene3”)
Parameters:

i_index (cat_variant) –

Return type:

ProductScene

remove(i_product_scene: ProductScene) → None

Note

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

Removes a product-scene from the ProductScenes collection.

Parameters:

iScene
The scene to remove.

Example:

This example removes the Engine product-scene from the ToolKits
collection.

ToolKits.Remove Engine
Parameters:

i_product_scene (ProductScene) –

Return type:

None