pycatia.cat_tps_interfaces.user_surfaces

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.cat_tps_interfaces.user_surfaces.UserSurfaces(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
UserSurfaces
generate(i_support: Reference) → UserSurface

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Generate(Reference iSupport) As UserSurface

Use this method in a Part. Creates a new user surface and adds it to the
Surfaces collection.

Parameters:

iSupport
The first reference that will support the user surface


Returns:
The created user surface
Example:
The following example creates a user surface names NewUserSurf from the
reference Ref in the Surfaces collection of the rootPart part in the partDoc
part document.

Set rootPart = partDoc.Part
Set NewUserSurf = rootPart.UserSurfaces.Add(Ref)
Parameters:

i_support (Reference) –

Return type:

UserSurface

generate_in_a_product_ctx(i_product: Product, i_prod_inst: Product, i_support: Reference) → UserSurface

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GenerateInAProductCtx(Product iProduct,
Product iProdInst,
Reference iSupport) As UserSurface

Use this method in a Product. Creates a new user surface and adds it to the
Surfaces collection.

Parameters:

iProduct
The level on which you want to create annotation (part or product).

iProdInst
The product instance where there is the geometry.
iSupport
The first reference that will support the user surface


Returns:
The created user surface
Parameters:
Return type:

UserSurface

item(i_index: cat_variant) → UserSurface

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Item(CATVariant iIndex) As UserSurface

Find a user surface inside the collection.

Parameters:

iIndex
The position of the users surface in the collection


Returns:
The user surface that is in the iIndex position in the collection
Parameters:

i_index (cat_variant) –

Return type:

UserSurface

make_user_surface_node(i_first_user_surf: UserSurface, i_second_user_surf: UserSurface) → UserSurface

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func MakeUserSurfaceNode(UserSurface iFirstUserSurf,
UserSurface iSecondUserSurf) As UserSurface

Usefull to create a User Surface Node from two others User Surface. Creates
a new user surface and adds it to the Surfaces collection.

Parameters:

iFirstUserSurf
The first User Surface to use.
iSecondUserSurf
The second User Surface to use.

Returns:
The created user surface
Parameters:
Return type:

UserSurface

make_user_surface_node_2(i_list_of_user_surfaces: tuple) → UserSurface

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func MakeUserSurfaceNode2(CATSafeArrayVariant iListOfUserSurfaces) As
UserSurface

Usefull to create a User Surface Node from a list of User Surfaces. Creates
a new user surface and adds it to the Surfaces collection.

Parameters:

iListOfUserSurfaces
The list User Surfaces to use.

Returns:
The created user surface
Parameters:

i_list_of_user_surfaces (tuple) –

Return type:

UserSurface