pycatia.navigator_interfaces.annotated_views

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.navigator_interfaces.annotated_views.AnnotatedViews(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

AnnotatedViews

A collection of AnnotatedView objects.

The method Product.GetTechnologicalObject (“AnnotatedViews”) on the root

product retrieves this collection.

add() → AnnotatedView

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func Add() As AnnotatedView

Creates an annotated view using the current viewpoint and adds it to the

AnnotatedView collection.

Returns:

The created AnnotatedView

Example:

This example creates a new AnnotatedView in the TheAnnotatedViews

collection.

Dim NewAnnotatedView As AnnotatedView

Set NewAnnotatedView = TheAnnotatedViews.Add

Return type:

AnnotatedView

add_from_viewpoint(i_viewpoint: ViewPoint3D) → AnnotatedView

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func AddFromViewpoint(Viewpoint3D iViewpoint) As

AnnotatedView

Creates an annotated view using a given viewpoint and adds it to the

AnnotatedView collection.

Parameters:

iViewpoint

The viewpoint.

Returns:

The created AnnotatedView

Example:

This example creates a new AnnotatedView in the TheAnnotatedViews

collection using a

AViewpoint viewpoint object.

Dim NewAnnotatedView As AnnotatedView

Set NewAnnotatedView = TheAnnotatedViews.AddFromViewpoint(AViewpoint)

Parameters:

i_viewpoint (ViewPoint3D) –

Return type:

AnnotatedView

item(i_index: cat_variant) → AnnotatedView

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func Item(CATVariant iIndex) As AnnotatedView

Returns an annotated view using its index or its name from the

AnnotatedViews collection.

Parameters:

iIndex

The index or the name of the AnnotatedView to retrieve from the

collection of AnnotatedViews. As a numerics, this index is the rank of the

AnnotatedView in the collection. The index of the first AnnotatedView in the

collection is 1, and the index of the last AnnotatedView is Count. As a string,

it is the name you assigned to the AnnotatedView.

Returns:

The retrieved AnnotatedView

Example:

This example retrieves in ThisAnnotatedView the ninth

AnnotatedView,

and in ThatAnnotatedView the AnnotatedView named

AnnotatedView3 from the TheAnnotatedViews collection.

Dim ThisAnnotatedView As AnnotatedView

Set ThisAnnotatedView = TheAnnotatedViews.Item(9)

Dim ThatAnnotatedView As AnnotatedView

Set ThatAnnotatedView = TheAnnotatedViews.Item(“AnnotatedView3”)

Parameters:

i_index (cat_variant) –

Return type:

AnnotatedView

remove(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub Remove(CATVariant iIndex)

Removes an annotated view from the AnnotatedViews

collection.

Parameters:

iIndex

The index or the name of the AnnotatedView to retrieve from he

collection of AnnotatedViews. As a numerics, this index is the rank of the

AnnotatedView in the collection. The index of the first AnnotatedView in the

collection is 1, and the index of the last AnnotatedView is Count. As a string,

it is the name you assigned to the AnnotatedView.

Example:

The following example removes the tenth AnnotatedView and the

AnnotatedView named

AnnotatedView2 from the TheAnnotatedViews

collection.

TheAnnotatedViews.Remove(10)

TheAnnotatedViews.Remove(“AnnotatedView2”)

Parameters:

i_index (cat_variant) –

Return type:

None