pycatia.drafting_2dL_interfaces.layout_2d_view

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.drafting_2dL_interfaces.layout_2d_view.Layout2DView(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
Layout2DView

The interface to access a Layout2D View.
activate() → None

Note

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

Activates the Layout2D view. Activating a Layout2D view means that this
Layout2D view is the one on which the end-user is now
working.

Example:
This example activates the ViewToWorkOn Layout2D view.

ViewToWorkOn.Activate()
Return type:

None

aligned_with_reference_view() → None

Note

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

Activates the alignment with the reference view. Activating the alignment
with the reference view restores the constraints that the reference view
imposes to the current Layout2D view.

Example:
This example activates the alignment from the MyView Layout2D view to
its reference view.

MyView.AlignedWithReferenceView()
Return type:

None

property angle: float

Note

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

Returns or sets the angle of the Layout2D view. The angle is measured
between the axis system of the Layout2D view and the axis system of the
Layout2D sheet where the Layout2D view lies. The angle is measured in radians
and is counted counterclockwise.

Example:
This example sets the angle of the MyView Layout2D view to 90 degrees
clockwise. You first need to compute the angle in radians and set the minus
sign to indicate the rotation is clockwise.

PI = 3.1415926535
Angle90Clockwise = -PI/2
MyView.Angle = Angle90Clockwise
Return type:

float

property arrows: DrawingArrows

Note

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

Returns the drawing arrow collection of the Layout2D view.

Example:
This example retrieves in ArrowCollection the collection of arrows of
the MyView Layout2D view.

Dim ArrowCollection As DrawingArrows
Set ArrowCollection = MyView.Arrows
Return type:

DrawingArrows

property components: DrawingComponents

Note

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

Returns the Layout2D component instances collection (i.e. ditto collection)
of the Layout2D view.

Example:
This example retrieves in ComponentCollection the collection of
component instances of the MyView Layout2D view.

Dim ComponentCollection As DrawingComponents
Set ComponentCollection = MyView.Components
Return type:

DrawingComponents

property dimensions: DrawingDimensions

Note

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

Returns the drawing dimension collection of the Layout2D
view.

Example:
This example retrieves in DimensionCollection the collection of
dimensions of the MyView Layout2D view.

Dim DimensionCollection As DrawingDimensions
Set DimensionCollection = MyView.Dimensions
Return type:

DrawingDimensions

property factory_2d: Factory2D

Note

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

Returns the 2D factory of the Layout2D view. Take care that you must open
edition on a sketch before adding or modifying elements in it. Take care that
you must close edition on a sketch to keep all modifications before saving
document. To get Sketch from factory2D:

Set mySketch = my2DFactory.GetParent


Example:
The following example returns in my2DFactory the 2D
factory
of the view myView:

Set my2DFactory = myView.Factory2D
Return type:

Factory2D

property frame_visualization: bool

Note

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

Returns or sets the Layout2D view frame visualization
state.
True if the Layout2D view frame is visible.

Example:
This example shows the frame of the MyView Layout2D
view.

MyView.FrameVisualization = True
Return type:

bool

property geometric_elements: GeometricElements

Note

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

Returns the collection of geometric elements included in the Layout2D view
sketch.

Example:
The following example returns in colGeometry the list of geometric
elements in the view myView:

Dim colGeometry As GeometricElements
Set colGeometry = MyView.GeometricElements
Return type:

GeometricElements

get_view_name(i_view_name_prefix: str, i_view_name_ident: str, i_view_name_suffix: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetViewName(CATBSTR iViewNamePrefix,
CATBSTR iViewNameIdent,
CATBSTR iViewNameSuffix)

Returns the prefix, the ident and the suffix of the name of the Layout2D
view. The method returns an error in case of 2D component reference. Do not
confuse with the method Name which can be different.

Example:

This example gets the prefix, the ident, and the suffix of the name

of the MyView Layout2D view


Dim MyPrefix, MyIdent, MySuffix As CATBSTR
MyView.GetViewName (MyPrefix, MyIdent, MySuffix)
Parameters:

  • i_view_name_prefix (str) –

  • i_view_name_ident (str) –

  • i_view_name_suffix (str) –

Return type:

None

property lock_status: bool

Note

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

Returns or sets the lock status of a Layout2D view.
precondition: This property does not exist for the detail view. In this
case, the method returns failed.

Example:
This example locks the ViewToWorkOn Layout2D view.

ViewToWorkOn.LockStatus = True
Return type:

bool

property pictures: DrawingPictures

Note

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

Returns the drawing picture collection of the Layout2D
view.

Example:
This example retrieves in PictureCollection the collection of pictures
of the MyView Layout2D view.

Dim PictureCollection As DrawingPictures
Set PictureCollection = MyView.Pictures
Return type:

DrawingPictures

property reference_view: Layout2DView

Note

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

Returns or sets the reference view. The reference view is also the parent
view to which the current Layout2D view is linked and which is used as
reference for alignment. Generally, the reference view is the front view, and
the other views, such as the top, bottom, left, and right views, are linked to
it. This reference Layout2D view is used:

When moving the current Layout2D view. Its location remains constrained
to the reference view, depending on its type. For example, a left view can move
horizontally and a top view can move vertically.
To update the scale of the current Layout2D view according to the
modification performed to the one of the reference Layout2D
view.

Example:
This example retrieves in ReferenceView the view used as reference by
the MyView Layout2D view.

Dim ReferenceView As Layout2DView
Set ReferenceView = MyView.RefView
Return type:

Layout2DView

save_edition() → None

Note

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

Saves the Sketch Edition. Once you have finished working with the Layout2D
view, you must save its edition in order to register modification for
UNDO/REDO. Indeed when activating a view, this view is open in edition while
the previous active view is closed in edition. So calling SaveEdition() before
exiting a macro without changing active view will allow a correct UNDO/REDO
behavior.

Example:
The following example saves the edition of the Layout2D view
MyView:

MyView.SaveEdition
Return type:

None

set_view_name(i_view_name_prefix: str, i_view_name_ident: str, i_view_name_suffix: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetViewName(CATBSTR iViewNamePrefix,
CATBSTR iViewNameIdent,
CATBSTR iViewNameSuffix)

Sets the prefix, the ident and the suffix of the name of the Layout2D view.
The method returns an error in case of 2D component reference. Do not confuse
with the method Name which can be different.

Example:

This example sets the prefix, the ident, and the suffix of the name

of the MyView Layout2D view respectively to “MyPrefix”,
“MyIdent”,
and “MySuffix”.


MyView.SetViewName (“MyPrefix”, “MyIdent”,
“MySuffix”)
Parameters:

  • i_view_name_prefix (str) –

  • i_view_name_ident (str) –

  • i_view_name_suffix (str) –

Return type:

None

size(o_values: tuple) → float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Size(CATSafeArrayVariant oValues)

Returns the bounding box of the Layout2D view.
Warning: This method is not implemented.

Parameters:

oValues
The values of the view bounding box: Xmin, Xmax, Ymin, Ymax


Example:



This example gets the bounding box of the ViewToWorkOn Layout2D
view.


Dim oXY(4) As Double
ViewToWorkOn.Size oXY
Xmin = oXY(0)
Xmax = oXY(1)
Ymin = oXY(2)
Ymax = oXY(3)
Parameters:

o_values (tuple) –

Return type:

Double

property tables: DrawingTables

Note

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

Returns the drawing table collection of the drawing view.

Example:
This example retrieves in TextCollection the collection of texts of the
MyView Layout2D view.

Dim TableCollection As DrawingTables
Set TableCollection = MyView.Tables
Return type:

DrawingTables

property texts: DrawingTexts

Note

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

Returns the drawing text collection of the Layout2D view.

Example:
This example retrieves in TextCollection the collection of texts of the
MyView Layout2D view.

Dim TextCollection As DrawingTexts
Set TextCollection = MyView.Texts
Return type:

DrawingTexts

property threads: DrawingThreads

Note

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

Returns the drawing thread collection of the Layout2D
view.

Example:
This example retrieves in ThreadCollection the collection of threads of
the MyView Layout2D view.

Dim ThreadCollection As DrawingThreads
Set ThreadCollection = MyView.Threads
Return type:

DrawingThreads

un_aligned_with_reference_view() → None

Note

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

Deactivates the alignment with the reference view. Deactivating the
alignment to the reference view removes the constraints that the reference view
imposes to the current Layout2D view. You can then, for example, move and
position it freely.

Example:
This example deactivates the alignment from the MyView Layout2D view to
its reference view.

MyView.UnAlignedWithReferenceView()
Return type:

None

property view_scale: float

Note

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

Returns or sets the scale of the Layout2D view.

Example:
This example sets the scale of the MyView Layout2D view to
0.5.

MyView.Scale = 0.5
Return type:

float

property visu_2d_mode: int

Note

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

Sets/Gets the 2D mode for background visualization of the
view.

See also:
CatView2DModeVisu
Example:

This example shows how to switch on the background 2D
mode

View1.Visu2DMode = catView2DModeNoShow
Returns:

enum cat_view_2d_mode_visu

Return type:

int

property visu_background: int

Note

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

Sets/Gets the 2D-3D background visu mode of the view ie in the 3D windows
and in the background of each view in every 2D context.

See also:
CatVisuBackgroundMode
Example:



This example shows how to set the background to
LowInt


View1.VisuBackground = catLowIntPick
Returns:

enum cat_visu_background_mode

Return type:

int

property visu_in_3d: int

Note

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

Sets/Gets the 3D visualization mode of the view in the 3D Viewer ie in the
3D windows and in the background of each view in every 2D
context.

See also:
CatVisuIn3DMode
Example:

This example shows how to make the View1 Layout2D view visible in
3D

View1.HideIn3DSize = catShowAll
Returns:

enum cat_visu_in_3d_mode

Return type:

int

property weldings: DrawingWeldings

Note

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

Returns the drawing welding collection of the Layout2D
view.

Example:
This example retrieves in weldingCollection the collection of weldings
of the MyView Layout2D view.

Dim weldingCollection As DrawingWeldings
Set weldingCollection = MyView.Weldings
Return type:

DrawingWeldings

property x: float

Note

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

Returns or sets the x coordinate of the Layout2D view coordinate system
origin. It is expressed with respect to the sheet coordinate system. This
coordinate, like any length, is measured in millimeters.

Example:
This example retrieves the x coordinate of the coordinate system origin
of the MyView.

X = MyView.x
Return type:

float

property y: float

Note

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

Returns or sets the y coordinate of the Layout2D view coordinate system
origin. It is expressed with respect to the sheet coordinate system. This
coordinate, like any length, is measured in millimeters.

Example:
This example sets the y coordinate of the coordinate system origin of
the MyView to 5 inches. You need first to convert the 5 inches into
millimeters.

NewYCoordinate = 5*25.4
MyView.y = NewYCoordinate
Return type:

float