pycatia.osm_interfaces.scene_product_data

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_product_data.SceneProductData(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
SceneProductData

The interface to access a CATIASceneProduct

Using this prefered syntax will enable mkdoc to document your
class.
property activation: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Activation() As boolean

Returns / Set the scene product’s activation state.

Example:

This example retrieves the activation state of the scenePrd
SceneProductData.

IsActivated = scenePrd.Hidden
Return type:

bool

get_real_colour(o_red: int, o_green: int, o_blue: int, o_inheritance: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetRealColor(long oRed,
long oGreen,
long oBlue,
long oInheritance)

Returns / Set the scene product’s color and inheritance.

Parameters:

iRed
A value between 0 and 255
iGreen
A value between 0 and 255
iBlue
A value between 0 and 255
iInheritance
Legal value:

0
No heritance
1
Heritance

Example:

This example retrieves the activation state of the scenePrd
SceneProductData.

Dim r, g, b, inh
scenePrd.GetRealColor r, g, b, inh
Parameters:

  • o_red (int) –

  • o_green (int) –

  • o_blue (int) –

  • o_inheritance (int) –

Return type:

None

get_real_transparency(o_transparency: int, o_inheritance: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetRealTransparency(long oTransparency,
long oInheritance)

Returns the scene product’s Transparency and inheritance.

Parameters:

oTransparency
A value between 0 and 255
iInheritance
Legal value:

0
No heritance
1
Heritance

Example:

This example retrieves the transparency of the scenePrd
SceneProductData.

Dim trans, inh
scenePrd.GetRealTransparency trans, inh
Parameters:

  • o_transparency (int) –

  • o_inheritance (int) –

Return type:

None

property hidden: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Hidden() As boolean

Returns / Set the scene product’s hide/show mode.

Example:

This example retrieves the hide/show mode of the scenePrd
SceneProductData.

IsHidden = scenePrd.Hidden
Return type:

bool

property move: Move

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Move() As Move (Read Only)

Returns the scene product’s move object. It aggregates a movable object to
which you can apply a move transformation by means of an isometry matrix. It
moves your product shape representation according to this
isometry.

Example:

This example retrieves the EngineMove move
in the scenePrd SceneProductData.

Dim EngineMove As Move
Set EngineMove = scenePrd.GetMove
Return type:

Move

property position: Position

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Position() As Position (Read Only)

Returns the scene product’s position object. The position object is the
object aggregated by the SceneProductData object that holds the position of the
master shape representation in the space in scene.

Example:

This example retrieves the EnginePosition
position
in the scenePrd SceneProductData.

Dim EnginePosition As Position
Set EnginePosition = scenePrd.GetPosition
Return type:

Position

set_real_colour(i_red: int, i_green: int, i_blue: int, i_inheritance: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetRealColor(long iRed,
long iGreen,
long iBlue,
long iInheritance)

Returns / Set the scene product’s color and inheritance.

Parameters:

iRed
A value between 0 and 255
iGreen
A value between 0 and 255
iBlue
A value between 0 and 255
iInheritance
Legal value:

0
No heritance
1
Heritance

Example:

This example retrieves the activation state of the scenePrd
SceneProductData.

scenePrd.SetRealColor 255,0,0,1
Parameters:

  • i_red (int) –

  • i_green (int) –

  • i_blue (int) –

  • i_inheritance (int) –

Return type:

None

set_real_transparency(i_transparency: int, i_inheritance: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetRealTransparency(long iTransparency,
long iInheritance)

Set the scene product’s Transparency and inheritance.

Parameters:

iTransparency
A value between 0 and 255
iInheritance
Legal value:

0
No heritance
1
Heritance

Example:

This example applies the transparency of the scenePrd
SceneProductData.

scenePrd.SetRealTransparency 10, 1
Parameters:

  • i_transparency (int) –

  • i_inheritance (int) –

Return type:

None