Properties
- Property NumExclusionRegions() As (Read Only)
- Retrieves the number of currently active exclusion regions.
- Property NumSupports() As (Read Only)
- Retrieves the number of supports.
- Property UR1() As
- Returns or sets the UR1 degree of freedom.
- Property UR2() As
- Returns or sets the UR2 degree of freedom.
- Property UR3() As
- Returns or sets the UR3 degree of freedom.
- Property localCsys() As
- Returns or sets the local coordinate system. If nothing is passed in then it defaults to the global coordinate system.
Methods
- Sub AddSupportFromPublication( iProduct, iPublication)
-
Adds a support to the coupling. If the support
already exists, it is removed from the coupling. If an attempt
to remove the last support is made, the support is maintained
and an error is returned.
- Parameters:
-
- iProduct
- The CATIA Product specifying the object to which the smooth coupling is applied.
- iPublication
- The CATIA Publication specifying the region to which the smooth coupling is applied.
Refer: CATIAPublication
- Sub AddSupportFromReference( iReference, iSupport)
-
AddSupportFromReference - adds a support to the coupling. If the support
already exists, it is removed from the coupling. If an attempt
to remove the last support is made, the support is maintained
and an error is returned.
- Parameters:
-
- iReference
- The reference to the product as a CATIAReference.
- iSupport
- The reference to the support as a CATIAReference.
- Sub ClearExclusionRegions()
- Clears the exclusion regions list.
- Sub ClearHandler()
- Clears the handler.
- Sub GetExclusionRegions( oProducts, oRegions)
-
Returns the exclusion regions for the coupling.
param oProducts
Returned safe array of products for the excluded region,
as CATIAReferences.
This array has a one-to-one mapping with the regions array.
- Parameters:
-
- oRegions
- Returned safe array of regions to exclude, as CATIAReferences. This array has a one-to-one mapping with the products array.
- Sub GetHandler( oProduct, oRef)
-
Returns the handler for the coupling.
- Parameters:
-
- oProduct
- The product for the handler.
- oRef
- The reference to the handler.
- Sub GetLocalCsysFromPublication( oProduct, oPubAxisSystem)
-
Gets the published local coordinate system of for the coupling.
- Parameters:
-
- oProduct
- The CATIA Product specifying the local coordinate system publication.
- oPubAxisSystem
- The CATIA Axis system.
Refer: CATIAAxisSystem
- Sub GetSupports( oProducts, oSupports)
-
Returns the supports for the coupling.
- Parameters:
-
- oProducts
- Returned safe array of products for the supports, as CATIAReferences. This array has a one-to-one mapping with the supports array.
- oSupports
- Returned safe array of supports, as CATIAReferences. This array has a one-to-one mapping with the products array.
- Sub SetExclusionRegions( iProducts, iRegions)
-
Sets the exclusion regions for the coupling. Any previously set
exclusion regions will be replaced with this new list.
The list of excluded regions can be cleared by passing in two
empty lists for the products and the regions. Note: null values
for products and regions are not accepted.
- Parameters:
-
- iProducts
- Safe array of products for the excluded region, as CATIAReferences. This array has a one-to-one mapping with the regions array.
- iRegions
- Safe array of regions to exclude, as CATIAReferences. This array has a one-to-one mapping with the products array.
- Sub SetHandler( iProduct, iRef)
-
Sets the handler for the coupling. Any previously set
handler will be replaced with this new value.
- Parameters:
-
- iProduct
- The product for the handler.
- iRef
- The reference to the handler.
- Sub SetHandlerFromPublication( iProduct, iPublication)
-
Sets the handler for the coupling. Any previously set
handler will be replaced with this new value.
- Parameters:
-
- iProduct
- The CATIA Product for handeler.
- iPublication
- The CATIA Publication for handeler.
Refer: CATIAPublication
- Sub SetLocalCsysFromPublication( iProduct, iPubAxisSystem)
-
Sets the published local coordinate system for the coupling.
Fails if the publication is not an axis system.
- Parameters:
-
- iProduct
- The CATIA Product specifying the local coordinate system publication.
- iPublication
- The CATIA Publication on the axis system.
Refer: CATIAPublication
- Sub SetSupports( iProducts, iRegions)
-
Sets the support regions for the coupling. Any previously set
support regions will be replaced with this new list.
At least one item in the list is required.
- Parameters:
-
- iProducts
- Safe array of products for the support region as CATIAReferences. This array has a one-to-one mapping with the regions array.
- iRegions
- Safe array of supports as CATIAReferences. This array has a one-to-one mapping with the products array.