pycatia.arrangement_interfaces.arrangement_area

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.arrangement_interfaces.arrangement_area.ArrangementArea(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
ArrangementArea

Use this object to access an ArrangementArea object’s properties and
functions.
Role: The ArrangementArea object is a type of Arrangement Object defining an
area containing other objects.
property arrangement_contours: ArrangementContours

Note

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

Returns the ArrangementContours collection object associated with an
ArrangementArea object.

Example:
This example retrieves the ArrangementContours collection object for
the objArea1 object.

Dim objArrContours As ArrangementContours
Set objArrContours = objArea1.ArrangementContours
Return type:

ArrangementContours

get_technological_object(i_application_type: str) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetTechnologicalObject(CATBSTR iApplicationType) As
CATBaseDispatch

Returns the applicative data whose type is the given
parameter.

Parameters:

iApplicationType
The type of applicative data searched.

Returns:
oApplicativeObj The matched applicative object.

Example:
This example retrieves the desired applicative object from the
objArea1 object.

Dim objProd As Product
objProd = objArea1.GetTechnologicalObject(“Product”)
Parameters:

i_application_type (str) –

Return type:

AnyObject

property height: float

Note

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

Returns or sets the Height of an ArrangementArea object.

Example:
This example retrieves the Height for the objArea1
object.

Dim dblAreaHeight As Double
dblAreaHeight = objArea1.Height
Return type:

float

property size: float

Note

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

Returns the Size of the ArrangementArea.

Example:
This example retrieves the Size of the objArea1
object.

Dim dblAreaSize As Double
dblAreaSize = objArea1.Size
Return type:

float

property visu_mode: int

Note

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

Returns or sets the Visualization Mode for an ArrangementArea
object.

Example:
This example sets the Visualization Mode for the objArea1 object to
CatArrangementAreaVisuModeVolume.

objArea1.VisuMode = CatArrangementAreaVisuModeVolume
Returns:

enum cat_arrangement_area_visu_mode

Return type:

int