pycatia.osm_interfaces.product_scene

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_scene.ProductScene(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

ProductScene

Represent the Product-Scene.

A Product-Scene stores a state of a product in a given

ProductDocument.

This state is composed of product properties, graphical attibutes, activation

status and position for each component of the product.

copy(i_type: int) → ProductScene

Note

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

o Func Copy(CatSceneType iType) As ProductScene

Creates another Product-Scene from the current one with the possibility to

have a different mode.

Parameters:

iType

The Product-Scene type

Returns:

The Product-Scene created from the current one.

Example:

This example returns whether the CopyScene Product-Scene created

from

the Configuration1 Product-Scene, with the DELTA

mode.

Dim type As CatSceneType

type = CatSceneTypeDelta

Dim CopyScene As ProductScene

CopyScene = Configuration1.Copy(type)

Parameters:

i_type (int) – enum cat_scene_type

Return type:

ProductScene

exists_in_scene(i_product: Product) → bool

Note

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

o Func ExistsInScene(Product iProduct) As boolean

Returns whether the product has overloaded attributes in the

Product-Scene.

Parameters:

iProduct

The product

Returns:

True if the Product-Scene overloads some of the product attributes.

Example:

This example returns whether the Engine product exists

in

the Configuration1 Product-Scene.

ExistsInSc = Configuration1.ExistsInScene(Engine)

Parameters:

i_product (Product) –

Return type:

bool

get_scene_product_data(i_product: Product) → SceneProductData

Note

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

o Func GetSceneProductData(Product iProduct) As

SceneProductData

Returns the SceneProductData associated to the given product in the

Product-Scene. If it does not exist yet, it is created.

Parameters:

iProduct

The product

Returns:

The SceneProductData associated to the given product.

Example:

This example returns SceneProductData associated to Engine

in

the NewSceneDelta Product-Scene.

Dim scenePrd As SceneProductData

type = NewSceneDelta.GetSceneProductData(Engine)

Parameters:

i_product (Product) –

Return type:

SceneProductData

property type: int

Note

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

o Property Type() As CatSceneType (Read Only)

Returns the type of the Product-Scene.

Example:

This example reads the type of NewSceneDelta

Product-Scene.

Dim type As CatSceneType

type = NewSceneDelta.Type

Returns:

enum cat_scene_type

Return type:

int