pycatia.osm_interfaces.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.scene.Scene(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

Scene

Represent the scene.

A 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.

get_definition(i_product: Product) → str

Note

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

o Func GetDefinition(Product iProduct) As CATBSTR

Returns the product’s definition.

Parameters:

iProduct

The product.

Returns:

The product’s definition.

Example:

This example retrieves the Engine product’s

definition

in the Configuration1 scene.

Dim Definition As String

Definition = Configuration1.GetDefinition(Engine)

Parameters:

i_product (Product) –

Return type:

str

get_description(i_product: Product) → str

Note

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

o Func GetDescription(Product iProduct) As CATBSTR

Returns the product’s description.

Parameters:

iProduct

The product.

Returns:

The product’s description.

Example:

This example retrieves the Engine product’s

description

in the Configuration1 scene.

Dim Description As String

Description = Configuration1.GetDescription(Engine)

Parameters:

i_product (Product) –

Return type:

str

get_master_shape_representation(i_product: Product, i_load_if_necessary: bool) → AnyObject

Note

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

o Func GetMasterShapeRepresentation(Product iProduct,

boolean iLoadIfNecessary) As CATBaseDispatch

Retrieves the product’s master shape representation.

Parameters:

iProduct.

The product

iLoadIfNecessary

Parameter to set to True if the master shape representation should

be loaded to determine if it exists, or to False otherwise.

Returns:

The product’s master shape representation.

Example:

This example retrieves the Engine product’s master shape

representation

in the Configuration1 scene.

Dim MSRep As Object

Set MSRep = Configuration1.GetMasterShapeRepresentation(Engine)

Parameters:

• i_product (Product) –

• i_load_if_necessary (bool) –

Return type:

AnyObject

get_move(i_product: Product) → Move

Note

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

o Func GetMove(Product iProduct) As Move

Returns the product’s move object. The move object is aggregated by the

product object and itself aggregates a movable object to which you can apply a

move transformation by means of an isometry matrix. It moves your product

master shape representation according to this isometry.

Parameters:

iProduct

The product

Returns:

The move.

Example:

This example retrieves the EngineMove move from the Engine

product

in the Configuration1 scene.

Dim EngineMove As Move

Set EngineMove = Configuration1.GetMove(Engine)

Parameters:

i_product (Product) –

Return type:

Move

get_nomenclature(i_product: Product) → str

Note

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

o Func GetNomenclature(Product iProduct) As CATBSTR

Returns the product’s nomenclature.

Parameters:

iProduct

The product.

Returns:

The product’s nomenclature.

Example:

This example retrieves the Engine product’s

nomenclature

in the Configuration1 scene.

Dim Nomenclature As String

Nomenclature = Configuration1.GetNomenclature(Engine)

Parameters:

i_product (Product) –

Return type:

str

get_part_number(i_product: Product) → str

Note

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

o Func GetPartNumber(Product iProduct) As CATBSTR

Returns the product’s part number.

Parameters:

iProduct

The product.

Returns:

The product’s part number.

Example:

This example retrieves the Engine product’s part

number

in the Configuration1 scene.

Dim PartNumber As String

PartNumber = Configuration1.GetPartNumber(Engine)

Parameters:

i_product (Product) –

Return type:

str

get_position(i_product: Product) → Position

Note

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

o Func GetPosition(Product iProduct) As Position

Returns the product’s position object in the scene. The position object is

the object aggregated by the product object that holds the position of the

master shape representation in the space.

Parameters:

iProduct

The product

Returns:

The position.

Example:

This example retrieves the EnginePosition position from the Engine

product

in the Configuration1 scene.

Dim EnginePosition As Position

Set EnginePosition = Configuration1.GetPosition(Engine)

Parameters:

i_product (Product) –

Return type:

Position

get_revision(i_product: Product) → str

Note

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

o Func GetRevision(Product iProduct) As CATBSTR

Returns the product’s revision number.

Parameters:

iProduct

The product.

Returns:

The product’s revision number.

Example:

This example retrieves the Engine product’s revision

number

in the Configuration1 scene.

Dim Revision As String

Revision = Configuration1.GetRevision(Engine)

Parameters:

i_product (Product) –

Return type:

str

get_source(i_product: Product) → int

Note

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

o Func GetSource(Product iProduct) As CatProductSource

Returns the product’s source.

Parameters:

iProduct

The product.

Returns:

The product’s source.

Example:

This example retrieves the Engine product’s

source

in the Configuration1 scene.

Dim Source

Source = Configuration1.GetSource(Engine)

Parameters:

i_product (Product) –

Return type:

enum cat_product_source

Return type:

int

has_a_master_shape_representation(i_product: Product) → bool

Note

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

o Func HasAMasterShapeRepresentation(Product iProduct) As

boolean

Returns whether the product has a master shape representation in the

scene.

Parameters:

iProduct

The product

Returns:

True if the product has a master shape representation.

Example:

This example returns whether the Engine product has a master shape

representation

in the Configuration1 scene.

HasMSRep = Configuration1.HasAMasterShapeRepresentation(Engine)

Parameters:

i_product (Product) –

Return type:

bool

upgrade_to_full() → ProductScene

Note

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

o Func UpgradeToFull() As ProductScene

Create a ProductScene in Full mode from the current Scene.

Returns:

The new ProductScene.

Example:

This example creates the FullScene ProductScene from the

Configuration1 scene.

Dim FullScene As ProductScene

Set FullScene = Configuration1.UpgradeToFull

Return type:

ProductScene

upgrade_to_partial() → ProductScene

Note

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

o Func UpgradeToPartial() As ProductScene

Create a ProductScene in Partial mode from the current

Scene.

Returns:

The new ProductScene.

Example:

This example creates the PartialScene ProductScene from the

Configuration1 scene.

Dim PartialScene As ProductScene

Set PartialScene = Configuration1.UpgradeToPartial

Return type:

ProductScene