part_interfaces¶

Note

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

o Property HybridShape() As HybridShape (Read Only)

Gets the underlying HybridShapeAffinity.

Example:

The following example explains how to retrieve the underlying

HybridShape Affinity

Dim oHybridShape as AnyObject

Set oHybridShape=oAffinity.HybridShape

oHybridShape.ElemToAffinity = reference1

Note

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

o Property AngularSpacing() As Angle (Read Only)

Returns the angle between two consecutive copies of a shape along the

repartition crown.

Example:

The following example returns in AngSpace1 the angular spacing of the

angular repartition firstRepartition:

Set AngSpace1 = firstRepartition.AngularSpacing

Note

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

o Property InstanceSpacing() As Angle (Read Only)

Returns the angle at which the pattern spacing is done for unequal angular

spacing mode.

Example:

The following example returns in AngSpace1 the angular spacing of the

angular repartition firstRepartition:

Set AngSpace1 = firstRepartition.AngularSpacing

Note

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

o Property FunctionalFace(Reference iFace) (Write Only)

Note

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

o Property FunctionalFaces() As References (Read Only)

Returns or sets the functional faces.

Example:

The following example returns in FunctionalFaces the list functional

faces of the AutoDraft AutoDraft, and then sets NewFunctionalFace as a

functional face:

Set FunctionalFaces = AutoDraft.FunctionalFace

AutoDraft.FunctionalFace = NewFunctionalFace

Note

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

o Property MainDraftAngle() As Reference

Returns or sets the main draft angle.

Example:

The following example returns in MainDraftAngle the main draft angle of

the AutoDraft AutoDraft, and then sets it to

NewMainDraftAngle.:

Set MainDraftAngle = AutoDraft.MainDraftAngle

AutoDraft.MainDraftAngle = NewMainDraftAngle

Note

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

o Property Mode() As Reference

Returns or sets the draft mode.

Example:

The following example returns in Mode the mode of the draft AutoDraft

AutoDraft, and then sets it to NewMode:

Set Mode = AutoDraft.Mode

AutoDraft.Mode = NewMode

Note

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

o Property PartingElement() As Reference

Returns or sets the parting element.

Example:

The following example returns in PartingElement the parting element of

the AutoDraft AutoDraft, and then sets it to

NewpartingElement:

Set PartingElement = AutoDraft.PartingElement

AutoDraft.PartingElement = NewPartingElement

Note

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

o Property PullingDirection() As Reference

Returns or sets the pulling direction.

Example:

The following example returns in PullingDirection the pulling direction

of the AutoDraft AutoDraft, and then sets it to

NewPullingDirection.:

Set PullingDirection = AutoDraft.PullingDirection

AutoDraft.PullingDirection = NewPullingDirection

Note

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

o Property CurvatureRadius() As Length (Read Only)

Returns the Curvature radius.

Example:

The following example returns in Curvature radius the Curvature radius

of the AutoFillet Autofillet:

Set Curvatureradius = Autofillet.Radius

Note

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

o Property FacesToFillet() As References (Read Only)

Returns or sets the faces to fillet.

Example:

The following example returns in facestofillet the faces required for

autofillet autoFillet, and then sets it to

NewFacestofillet:

Set Facestofillet = autoFillet.Facestofillet

autofillet.Facestofillet = NewFacestofillet

Note

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

o Property FacesToFillets(Reference iFace) (Write Only)

Note

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

o Property FilletRadius() As Length (Read Only)

Returns the Fillet radius.

Example:

The following example returns in fillet radius the fillet radius of the

AutoFillet Autofillet:

Set Filletradius = Autofillet.Radius

Note

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

o Property FunctionalFace(Reference iFace) (Write Only)

Note

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

o Property FunctionalFaces() As References (Read Only)

Returns or sets the functional face.

Example:

The following example returns in functionalface the functional face of

the autofillet autoFillet, and then sets it to

NewfunctionalFace:

Set functionalFace = autoFillet.FunctionalFace

autofillet.FunctionalFace = NewfunctionalFace

Note

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

o Property PartingElement() As Reference

Returns or sets the parting element.

Example:

The following example returns in partingelement the parting element of

the autofillet autoFillet, and then sets it to Newparting

element:

Set Parting element = autoFillet.PartingElement

autofillet.PartingElement = NewPartingElement

Note

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

o Property RoundRadius() As Length (Read Only)

Returns the Round radius.

Example:

The following example returns in round radius the round radius of the

AutoFillet Autofillet:

Set roundradius = Autofillet.Radius

Note

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

o Property RoundRadiusActivation() As boolean

Returns the AutoFillet RoundRadiusActivation flag (for AutoFillet

only).

It returns 1 if RoundRadius is activated, 0 if not.

Returns:

oRoundRadActivation The RoundRadActivation flag as an

int

Example:

Note

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

o Property SliversAndCrack(Reference iSlivers) (Write Only)

Note

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

o Property SliversAndCracks() As References (Read Only)

Returns or sets the slivers face.

Example:

The following example returns in slivers the sliver face of the

autofillet autoFillet, and then sets it to Newsliver:

Set sliversFace = autoFillet.SliversFace

autofillet.SliversFace = NewsliversFace

Note

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

o Property SupportSurface() As Reference

Returns or sets the support surface.

Example:

The following example returns in SupportSurface the support surface

required for autofillet autoFillet, and then sets it to

NewSupportSurface:

Set SupportSurface = autoFillet.SupportSurface

autofillet.SupportSurface = NewSupportSurface

Note

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

o Property HybridShape() As HybridShape (Read Only)

Gets the underlying HybridShapeAxisToAxis.

Example:

The following example explains how to retrieve the underlying

HybridShape AxisToAxis

Dim oHybridShape as AnyObject

Set oHybridShape=oAxisToAxis.HybridShape

oHybridShape.ElemToAxisToAxis = reference1

Note

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

o Property Body() As Body (Read Only)

Returns the inserted body.

Note

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

o Sub SetOperatedObject(Reference iReferenceObject)

Modifies the Second Operand. input object to replace with Body or Volume

Note

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

o Sub SetOperatingVolume(Reference iReferenceObject)

Swaps the operands. Both the Operands must be Volume. This is available

only for Volume Add and Volume UnionTrim Operations

Note

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

o Sub AddElementToChamfer(Reference iElementToChamfer)

Adds a new geometrical element to be chamfered.

Parameters:

iElementToChamfer

The new element to be chamfered

The following

Boundary object is supported: TriDimFeatEdge.

Example:

The following example adds the new element element to be chamfered for the

firstChamfer chamfer:

firstChamfer.AddElementToChamfer(element)

Note

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

o Property Angle() As Angle (Read Only)

Returns the chamfer angle. This is valid only if the chamfer is defined

using a length and an angle, that is if the chamfer definition mode

CatChamferMode is set to catLengthAngleChamfer.

Example:

The following example returns in angle the angle of the firstChamfer

chamfer:

Set angle = firstChamfer.Angle

Note

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

o Property ElementsToChamfer() As References (Read Only)

Returns the collection of geometrical elements to be

chamfered.

Example:

The following example returns in list the list of elements of the

firstChamfer chamfer:

Set list = firstChamfer.ElementsToChamfer

Note

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

o Property Length1() As Length (Read Only)

Returns the chamfer first length. This is the first length if the chamfer

is defined by two lengths, or the chamfer if the chamfer is defined by a

length and an angle.

Example:

The following example returns in length1 the first length of the

firstChamfer chamfer:

Set length1 = firstChamfer.Length1

Note

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

o Property Length2() As Length (Read Only)

Returns the chamfer second length. This is valid only if the chamfer is

defined using two lengths, that is if the chamfer definition mode

CatChamferMode is set to catTwoLengthChamfer.

Example:

The following example returns in length2 the second length of the

firstChamfer chamfer:

Set length2 = firstChamfer.Length2

Note

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

o Property Mode() As CatChamferMode

Returns or sets the chamfer definition mode. The chamfer definition mode

enables the chamfer to be defined using either two lengths or a length and an

angle.

Example:

The following example returns in mode how the parameters of the

firstChamfer chamfer are defined, and then sets it to

catTwoLengthChamfer:

Set mode = firstChamfer.Mode

firstChamfer.Mode = catTwoLengthChamfer

Note

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

o Property Orientation() As CatChamferOrientation

Returns or sets the chamfer orientation.

Example:

The following example returns in orient the orientation mode of the

firstChamfer chamfer, and then sets it to

catReverseChamfer:

Set orient = firstChamfer.Orientation

firstChamfer.Orientation = catReverseChamfer

Note

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

o Property Propagation() As CatChamferPropagation

Returns or sets the propagation mode of the geometrical elements to be

chamfered.

Example:

The following example returns in prop the propagation mode of the

firstChamfer chamfer, and then sets it to

catMinimalChamfer:

Set prop = firstChamfer.Propagation

firstChamfer.Propagation = catMinimalChamfer

Note

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

o Sub WithdrawElementToChamfer(Reference iElementToWithdraw)

Withdraws a geometrical element from those to be

chamfered.

Parameters:

iElementToWithdraw

The existing element to withdraw

The following

Boundary object is supported: TriDimFeatEdge.

Example:

The following example withdraws an existing element element to be chamfered

from the firstChamfer chamfer:

firstChamfer.WithdrawElementToChamfer(element)

Note

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

o Property AngularDirectionRow() As IntParam (Read Only)

Returns the position of the shape to be copied along the angular

direction.

Example:

The following example returns in AngularDirPos the position of the

shape to be copied along the angular direction.

Set AngularDirPos = firstPattern.AngularDirectionRow

Note

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

o Property AngularRepartition() As AngularRepartition (Read

Only)

Returns the angular repartition. The angular repartition is the repartition

on a crown.

Example:

The following example returns in repartA the angular repartition of the

circular pattern firstPattern:

Set repartA = firstPattern.AngularRepartition

Note

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

o Property CircularPatternParameters() As

CatCircularPatternParameters

Returns or sets the circular pattern parameters required to define the

pattern. These parameters are used when reading the CATIAAngularRepartition

properties.

Example:

The following example returns in parameters the circular pattern

parameters of the firstPattern circular pattern, and then sets it to

catCompleteCrown, so that only the number of instances is used to define the

Pattern:

Set parameters = firstPattern.CircularPatternParameters

Set firstPattern.CircularPatternParameters = catCompleteCrown

Note

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

o Sub GetRotationAxis(CATSafeArrayVariant ioRotationAxis)

Returns the rotation axis. The rotation axis is returned as an array

containing the rotation axis vector components. Assume this array is

oRotationAxis. It contains:

oRotationAxis[0],oRotationAxis[1],oRotationAxis[2]

The X, Y, and Z rotation axis vector components

Example:

The following example returns in axisArray the rotation axis components

of the circular pattern firstPattern:

Call firstPattern.GetRotationAxis(axisArray)

Set x = axisArray[0]

Set y = axisArray[1]

Set z = axisArray[2]

Note

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

o Sub GetRotationCenter(CATSafeArrayVariant

ioRotationCenter)

Returns the rotation center if the user defined it. Returns E_FAIL if no

rotation center has been defined The rotation center is returned as an array

containing the rotation center coordinates. Assume this array is

oRotationCenter. It contains:

oRotationCenter[0],oRotationCenter[1],oRotationCenter[2]

The X, Y, and Z rotation center coordinates

Example:

The following example returns in centerArray the rotation center

coordinates of the circular pattern firstPattern, and saves them in

variables:

Call firstPattern.GetRotationCenter(centerArray)

x = centerArray[0]

y = centerArray[1]

z = centerArray[2]

Note

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

o Property RadialAlignment() As boolean

Returns or sets whether the copied shapes should be rotated or radial

aligned with respect to the original one.

True if the copied shapes are rotated.

Example:

The following example returns in alignedR the radial alignment of the

circular pattern firstPattern, and then sets it to

False:

Set alignedR = firstPattern.RadialAlignment

firstPattern.RadialAlignment = False

Note

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

o Property RadialDirectionRow() As IntParam (Read Only)

Returns the position of the shape to be copied along the radial

direction.

Example:

The following example returns in RadialDirPos the position of the shape

to be copied along the radial direction.

Set RadialDirPos = firstPattern.RadialDirectionRow

Note

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

o Property RadialRepartition() As LinearRepartition (Read

Only)

Returns the radial repartition. The radial repartition is the repartition

along a radius.

Example:

The following example returns in repartR the radial repartition of the

circular pattern firstPattern:

Set repartR = firstPattern.RadialRepartition

Note

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

o Property RotationOrientation() As boolean

Returns or sets whether the shapes are copied clockwise on the crowns with

respect to the rotation axis direction.

True if the shapes are copied counterclockwise when the rotation axis

direction goes towards you when you look at the crown.

Example:

The following example returns in alignedAxis whether the circular

pattern firstPattern is built clockwise, and then sets it to

True:

alignedAxis = firstPattern.RotationOrientation

firstPattern.RotationOrientation = True

Note

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

o Sub SetInstanceAngularSpacing(long iInstanceNumber,

double iAngularSpacing)

Sets the InstanceAngularSpacing.

Parameters:

iInstanceNumber

The Instance Number

iAngularSpacing

The Angular Spacing

Example:

The following example sets the InstanceAngularSpacing of the circular

pattern

Note

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

o Sub SetRotationAxis(Reference iRotationAxis)

Sets the rotation axis.

Parameters:

iRotationAxis

The rotation axis. It is passed as reference and can be valuated

with a line, an edge or a plane reference: in this case the plane normal is

taken into account.

The following

Boundary objects are supported: PlanarFace, CylindricalFace

RectilinearTriDimFeatEdge and RectilinearBiDimFeatEdge.

Example:

The following example sets the rotation axis of the circular pattern

firstPattern with the refLine1 reference:

firstPattern.SetRotationAxis refLine1

Note

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

o Sub SetRotationCenter(Reference iRotationCenter)

Sets the rotation center.

Parameters:

iRotationCenter

The rotation center

Example:

The following example sets the rotation center of the circular pattern

firstPattern with point1Ref point:

firstPattern.SetRotationCenter point1Ref

Note

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

o Sub SetUnequalInstanceNumber(long iInstanceNumber)

Sets the Instance Number.

Parameters:

iInstanceNumber

The Instance Number

Example:

The following example modifies the instance number for unequal angular

spacing

Note

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

o Sub SetUnequalStep(long iInstanceNumber)

This method is deprecated Sets the UnequalStep.

Parameters:

iInstanceNumber

The Instance Number

Example:

The following example creates the number of pattern spacing objects in

pattern object

Note

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

o Property AngularDirectionRow() As IntParam (Read Only)

Returns the position of the shape to be copied along the angular

direction.

Example:

The following example returns in AngularDirPos the position of the

shape to be copied along the angular direction.

Set AngularDirPos = firstPattern.AngularDirectionRow

Note

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

o Property AngularRepartition() As AngularRepartition (Read

Only)

Returns the angular repartition. The angular repartition is the repartition

on a crown.

Example:

The following example returns in repartA the angular repartition of the

circular pattern firstPattern:

Set repartA = firstPattern.AngularRepartition

Note

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

o Property CircularPatternParameters() As

CatCircularPatternParameters

Returns or sets the circular pattern parameters required to define the

pattern. These parameters are used when reading the CATIAAngularRepartition

properties.

Example:

The following example returns in parameters the circular pattern

parameters of the firstPattern circular pattern, and then sets it to

catCompleteCrown, so that only the number of instances is used to define the

Pattern:

Set parameters = firstPattern.CircularPatternParameters

Set firstPattern.CircularPatternParameters = catCompleteCrown

Note

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

o Sub GetRotationAxis(CATSafeArrayVariant ioRotationAxis)

Returns the rotation axis. The rotation axis is returned as an array

containing the rotation axis vector components. Assume this array is

oRotationAxis. It contains:

oRotationAxis[0],oRotationAxis[1],oRotationAxis[2]

The X, Y, and Z rotation axis vector components

Example:

The following example returns in axisArray the rotation axis components

of the circular pattern firstPattern:

Call firstPattern.GetRotationAxis(axisArray)

Set x = axisArray[0]

Set y = axisArray[1]

Set z = axisArray[2]

Note

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

o Sub GetRotationCenter(CATSafeArrayVariant

ioRotationCenter)

Returns the rotation center if the user defined it. Returns E_FAIL if no

rotation center has been defined The rotation center is returned as an array

containing the rotation center coordinates. Assume this array is

oRotationCenter. It contains:

oRotationCenter[0],oRotationCenter[1],oRotationCenter[2]

The X, Y, and Z rotation center coordinates

Example:

The following example returns in centerArray the rotation center

coordinates of the circular pattern firstPattern, and saves them in

variables:

Call firstPattern.GetRotationCenter(centerArray)

x = centerArray[0]

y = centerArray[1]

z = centerArray[2]

Note

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

o Property RadialAlignment() As boolean

Returns or sets whether the copied shapes should be rotated or radial

aligned with respect to the original one.

True if the copied shapes are rotated.

Example:

The following example returns in alignedR the radial alignment of the

circular pattern firstPattern, and then sets it to

False:

Set alignedR = firstPattern.RadialAlignment

firstPattern.RadialAlignment = False

Note

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

o Property RadialDirectionRow() As IntParam (Read Only)

Returns the position of the shape to be copied along the radial

direction.

Example:

The following example returns in RadialDirPos the position of the shape

to be copied along the radial direction.

Set RadialDirPos = firstPattern.RadialDirectionRow

Note

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

o Property RadialRepartition() As LinearRepartition (Read

Only)

Returns the radial repartition. The radial repartition is the repartition

along a radius.

Example:

The following example returns in repartR the radial repartition of the

circular pattern firstPattern:

Set repartR = firstPattern.RadialRepartition

Note

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

o Property RotationOrientation() As boolean

Returns or sets whether the shapes are copied clockwise on the crowns with

respect to the rotation axis direction.

True if the shapes are copied counterclockwise when the rotation axis

direction goes towards you when you look at the crown.

Example:

The following example returns in alignedAxis whether the circular

pattern firstPattern is built clockwise, and then sets it to

True:

alignedAxis = firstPattern.RotationOrientation

firstPattern.RotationOrientation = True

Note

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

o Sub SetInstanceAngularSpacing(long iInstanceNumber,

double iAngularSpacing)

Sets the InstanceAngularSpacing.

Parameters:

iInstanceNumber

The Instance Number

iAngularSpacing

The Angular Spacing

Example:

The following example sets the InstanceAngularSpacing of the circular

pattern

Note

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

o Sub SetRotationAxis(Reference iRotationAxis)

Sets the rotation axis.

Parameters:

iRotationAxis

The rotation axis. It is passed as reference and can be valuated

with a line, an edge or a plane reference: in this case the plane normal is

taken into account.

The following

Boundary objects are supported: PlanarFace, CylindricalFace

RectilinearTriDimFeatEdge and RectilinearBiDimFeatEdge.

Example:

The following example sets the rotation axis of the circular pattern

firstPattern with the refLine1 reference:

firstPattern.SetRotationAxis refLine1

Note

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

o Sub SetRotationCenter(Reference iRotationCenter)

Sets the rotation center.

Parameters:

iRotationCenter

The rotation center

Example:

The following example sets the rotation center of the circular pattern

firstPattern with point1Ref point:

firstPattern.SetRotationCenter point1Ref

Note

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

o Sub SetUnequalInstanceNumber(long iInstanceNumber)

Sets the Instance Number.

Parameters:

iInstanceNumber

The Instance Number

Example:

The following example modifies the instance number for unequal angular

spacing

Note

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

o Sub SetUnequalStep(long iInstanceNumber)

This method is deprecated Sets the UnequalStep.

Parameters:

iInstanceNumber

The Instance Number

Example:

The following example creates the number of pattern spacing objects in

pattern object

Note

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

o Sub AddObjectToFillet(Reference iObjectToFillet)

Adds a new sub-element to be filleted. This sub-element is usually an

edge.

Parameters:

iObjectToFillet

The sub-element to be filleted

The following

Boundary object is supported: TriDimFeatEdge.

Example:

The following example adds a new geometrical element element to be filleted

by the constant radius edge fillet firstCstEdgeFillet:

firstCstEdgeFillet.AddObjectToFillet(element)

Note

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

o Property ObjectsToFillet() As References (Read Only)

Returns the collection of reference elements to be

filleted.

Example:

The following example returns in elements the reference elements to be

filleted of the constant radius edge fillet

firstCstEdgeFillet:

Set elements = firstCstEdgeFillet.ObjectsToFillet

Note

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

o Property Radius() As Length (Read Only)

Returns the edge fillet constant radius.

Example:

The following example returns in radius the radius of the constant

radius edge fillet firstCstEdgeFillet:

Set radius = firstCstEdgeFillet.Radius

Note

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

o Sub WithdrawObjectToFillet(Reference iObjectToWithdraw)

Withdraws a sub-element from those to be filleted. This sub-element is

usually an edge.

Parameters:

iObjectToWithdraw

The sub-element to withdraw

The following

Boundary object is supported: TriDimFeatEdge.

Example:

The following example withdraws the geometrical element element from those

to be filleted by the constant radius edge fillet

firstCstEdgeFillet:

firstCstEdgeFillet.WithdrawObjectToFillet(element)

Note

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

o Property Filters() As DefeaturingFilters (Read Only)

Returns the filter collection of the Defeaturing. The returned object is

the filter collection associated to this Defeaturing object. All changes

applied to the returned collection will be automatically applied to the

Defeaturing object. As a consequence there is no need to affect the collection

to the defeaturing after the change to update the

property.

Returns:

oFilters The filter collection (see DefeaturingFilters for list of

possible actions)

Example:

The following example returns in myDefeaturingFiltersCollection the

filter collection of the Defeaturing

firstDefeaturing:

Set myDefeaturingFiltersCollection = firstDefeaturing.Filters

Note

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

o Func getMaximumActivity(CATBSTR iRangeId) As boolean

Note

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

o Func getMaximumAngle(CATBSTR iRangeId) As Angle

Note

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

o Func getMaximumLength(CATBSTR iRangeId) As Length

Note

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

o Func getMaximumValue(CATBSTR iRangeId) As double

Note

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

o Func getMinimumActivity(CATBSTR iRangeId) As boolean

Returns the minimum or maximum value activity of the filter for the given

range id.

Parameters:

iRangeId

The identificator of the range on which the minimum/maximum should

be read - if iRangeId is empty or equal to “Default”, takes the default range

as defined by the filter (“RibbonRadius” for FilletFilter, “MainDiameter” for

HoleFilter) - else iRangeId should be chosen among: *

{“RibbonRadius”,”RibbonAngle”,”RibbonLength”} for FilletFilter *

{“MainDiameter”} for HoleFilter * any defined and supported range id in case of

a user-defined filter

Returns:

oValue The filter minimum/maximum activity for the specified

range

Example:

The following example returns in theMinActivity the minimum value

activity of filter myFilter for the range myRange:

Set theMinActivity = myFilter.getMinimumActivity(myRange)

Note

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

o Func getMinimumAngle(CATBSTR iRangeId) As Angle

Note

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

o Func getMinimumLength(CATBSTR iRangeId) As Length

Note

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

o Func getMinimumValue(CATBSTR iRangeId) As double

Returns the minimum or maximum value of the filter for the given range id,

if defined and active.

Parameters:

iRangeId

The identificator of the range on which the minimum/maximum should

be read - if iRangeId is empty or equal to “Default”, takes the default range

as defined by the filter (“RibbonRadius” for FilletFilter, “MainDiameter” for

HoleFilter) - else iRangeId should be chosen among: *

{“RibbonRadius”,”RibbonAngle”,”RibbonLength”} for FilletFilter *

{“MainDiameter”} for HoleFilter * any defined and supported range id in case of

a user-defined filter

Returns:

oValue The filter minimum/maximum value for the specified range if

defined and active ELSE the method FAILS (to avoid this,

getMinimumValueActivity/getMaximumValueActivity can be called prior to calling

getMinimumValue/getMaximumValue) Signature with double works for angles as well

as for lengths / EXPRESSED in MODEL UNIT (mm/deg) Signatures with CATIALength

or CATIAAngle must be used with care and will fail if the range nature and the

expected type are incompatible

Example:

The following example returns in theMinValue the minimum value of

filter myFilter for the range myRange:

theMinValue = myFilter.getMinimumValue(myRange)

The following example returns in theMinAngle the minimum value as

an angle of filter myFilter for the range myRange:

Set theMinAngle = myFilter.getMinimumAngle(myRange)

The following example returns in theMaxLength the maximum value as

a length of filter myFilter for the range myRange:

Set theMaxLength = myFilter.getMaximumLength(myRange)

Note

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

o Sub setMaximumActivity(CATBSTR iRangeId,

boolean iValue)

Note

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

o Sub setMaximumValue(CATBSTR iRangeId,

double iValue)

Note

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

o Sub setMinimumActivity(CATBSTR iRangeId,

boolean iValue)

Sets the defeaturing minimum or maximum value activity of the filter for

the given range id.

Parameters:

iRangeId

The identificator of the range on which the minimum/maximum should

be read - if iRangeId is empty or equal to “Default”, takes the default range

as defined by the filter (“RibbonRadius” for FilletFilter, “MainDiameter” for

HoleFilter) - else iRangeId should be chosen among: *

{“RibbonRadius”,”RibbonAngle”,”RibbonLength”} for FilletFilter *

{“MainDiameter”} for HoleFilter * any defined and supported range id in case of

a user-defined filter

iValue

The filter minimum/maximum activity for the specified

range

Example:

The two following examples set theMaxActivity as the maximum

value activity of filter myFilter for the range

myRange:

Call myFilter.setMaximumActivity(myRange,theMaxActivity)

myFilter.setMaximumActivity myRange

theMaxActivity

Note

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

o Sub setMinimumValue(CATBSTR iRangeId,

double iValue)

Sets the minimum or maximum value of the filter for the given range id.

Forces the activation of the minimum or maximum value if not the case

yet.

Parameters:

iRangeId

The identificator of the range on which the minimum/maximum should

be read - if iRangeId is empty or equal to “Default”, takes the default range

as defined by the filter (“RibbonRadius” for FilletFilter, “MainDiameter” for

HoleFilter) - else iRangeId should be chosen among: *

{“RibbonRadius”,”RibbonAngle”,”RibbonLength”} for FilletFilter *

{“MainDiameter”} for HoleFilter * any defined and supported range id in case of

a user-defined filter

iValue

The filter minimum/maximum value for the specified range / MUST BE

EXPRESSED in MODEL UNIT (mm/deg) iValue must be consistent with the other value

if defined and active - new minimum iValue must be smaller than existing active

maximum value if any - new maximum iValue must be larger than existing active

minimum value if any ELSE the method FAILS

Example:

The two following examples set theMaxValue as the maximum value

of filter myFilter for the range myRange:

Call

myFilter.setMaximumValue(myRange,theMaxValue)

myFilter.setMaximumValue myRange theMaxValue

Note

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

o Func Add(CATBSTR iFilterTypeToAdd) As long

Creates a new filter and adds it to the Defeaturing filters

collection.

Parameters:

iFilterTypeToAdd

The type of the new filter to add among : - “DefeaturingFilletFilter” -

“DefeaturingHoleFilter” - or any user-defined filter’s type

Returns:

oAddedFilterIndex The added filter’s index - equals to 0 if

FAILED

Example:

The following example adds a new filter of type theFilterType to

defeaturing colelction firstDefeaturingFilters and returns the index theIndex

of the new filter

Set theIndex = firstDefeaturingFilters.Add(theFilterType)

Note

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

o Func Item(CATVariant iFilterId) As DefeaturingFilter

Returns the filter of the Defeaturing filters collection using its index or

its name.

Parameters:

iFilterId

The index or the name of the filter to retrieve As a numerics, must

be in [1;Count])

Returns:

oFilter The filter (see DefeaturingFilter for list of possible

actions)

Example:

The following example returns in myFilter the filter number

theIndex of Defeaturing collection

firstDefeaturingFilters:

Set myFilter = firstDefeaturingFilters.Item(theIndex)

Note

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

o Sub Remove(CATVariant iFilterId)

Removes a filter from the Defeaturing filters collection and deletes it,

using its index or its name.

Parameters:

iFilterId

The index or the name of the filter to retrieve As a numerics, must

be in [1;Count])

Example:

The two following examples remove the filter number theIndex

from Defeaturing collection

firstDefeaturingFilters:

Call firstDefeaturingFilters.Remove(theIndex)

firstDefeaturingFilters.Remove theIndex

Note

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

o Property DraftDomains() As DraftDomains (Read Only)

Returns the collection of draft domains.

Example:

The following example returns in list the collection of draft domains

of the firstDraft draft:

Set list = firstDraft.DraftDomains

Note

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

o Property Mode() As CatDraftMode

Returns or sets the draft mode.

Example:

The following example returns in mode the draft mode of the firstDraft

draft, and then sets it to

CatReflectKeepFaceDraftMode:

Set mode = firstDraft.Mode

Set firstDraft.Mode = CatReflectKeepFaceDraftMode

Note

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

o Property PartingElement() As Reference

Returns or sets the draft parting element.

To set the property, you can use the following Boundary object:

PlanarFace.

Example:

The following example returns in element the parting element of the

firstDraft draft, and then sets it to the element2 geometrical

element:

Set element = firstDraft.PartingElement

Set firstDraft.PartingElement = element2

Note

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

o Sub AddFaceToDraft(Reference iFace)

Adds a face to those to be drafted.

Parameters:

iFace

The face to add to those to be drafted

The following

Boundary object is supported: ScFace.

Example:

The following example adds the face NewFaceToDraft to the draft domain

CurrentDraftDomain:

CurrentDraftDomain.AddFaceToDraft(NewFaceToDraft)

Note

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

o Property DraftAngle() As Angle (Read Only)

Returns the draft angle.

Example:

The following example returns in angle the draft angle of the draft

domain firstDraftDomain:

Set angle = firstDraftDomain.DraftAngle

Note

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

o Property FacesToDraft() As References (Read Only)

Returns the faces to be drafted. They are returned as a collection of

reference geometric elements.

Example:

The following example returns the collection of faces to be drafted of

the draft domain firstDraftDomain in list:

Set list = firstDraftDomain.FacesToDraft

Note

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

o Sub GetPullingDirection(CATSafeArrayVariant

ioPullingDirection)

Returns the draft pulling direction. The pulling direction is returned as

an array containing the pulling direction vector components. Assume this array

is PullDir. It contains:

PullDir[0],PullDir[1],PullDir[2]

The X, Y, and Z pulling direction vector components

Example:

The following example returns in PullDir the pulling direction vector

components of the draft domain firstDraftDomain:

Set PullDir = firstDraftDomain.PullingDirection

Set x = PullDir[0]

Set y = PullDir[1]

Set z = PullDir[2]

Note

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

o Property MultiselectionMode() As CatDraftMultiselectionMode

Changes the multiselection mode.

Parameters:

iMultiselectionMode.

The elements to be drafted can be selected explicitly

(CATNoneDraftMultiselectionMode) or can implicitly selected as neighbors of the

neutral face (CATMultiselectionByNeutralMode)

Example:

The following example returns in MultiselMode the

multiselection mode of the draft domain firstDraftDomain, and then sets it to

CATMultiselectionByNeutralMode

Set MultiselMode = firstDraftDomain.MultiselectionMode

firstDraftDomain.MultiselectionMode = CATMultiselectionByNeutralMode

Note

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

o Property NeutralElement() As Reference

Returns or sets the draft neutral element.

To set the property, you can use the following Boundary object:

PlanarFace.

Example:

The following example returns in neutral the neutral element of the

draft domain firstDraftDomain, and then sets it to

newNeutral:

Set neutral = firstDraftDomain.NeutralElement

firstDraftDomain.NeutralElement = newNeutral

Note

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

o Property NeutralPropagationMode() As

CatDraftNeutralPropagationMode

Returns or sets the neutral element propagation mode. This mode is used

when computing the needed neutral elements.

Example:

The following example returns in propMode the neutral propagation mode

of the draft domain firstDraftDomain, and then sets it to

CATSmoothDraftNeutralPropagationMode so that the neutral propagation will now

be smooth:

Set propMode = firstDraftDomain.NeutralPropagationMode

firstDraftDomain.NeutralPropagationMode = CATSmoothDraftNeutralPropagationMode

Note

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

o Property PullingDirectionElement() As Reference

Returns or sets the draft pulling direction element.

To set the property, you can use one of the following Boundary objects:

PlanarFace or RectilinearTriDimFeatEdge.

Example:

The following example returns in pullingdirection the pulling direction

element of the draft domain firstDraftDomain, and then sets it to

newPullingDirection:

Set pullingdirection = firstDraftDomain.NeutralElement

firstDraftDomain.PullingDirectionElement = newPullingDirection

Note

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

o Sub RemoveFaceToDraft(Reference iFace)

Removes a face from those to be drafted.

Parameters:

iFace

The face to be removed from those to be drafted

The following

Boundary object is supported: Face.

Example:

The following example removes the face FaceToRemove from the draft domain

CurrentDraftDomain:

CurrentDraftDomain.RemoveFaceToDraft(FaceToRemove)

Note

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

o Sub SetPullingDirection(double iX,

double iY,

double iZ)

Sets the draft pulling direction.

Parameters:

iX,iY,iZ

The X, Y, and Z pulling direction vector components

Example:

The following example sets the draft pulling direction of the draft

domain firstDraftDomain to the direction with the vector components 10, -5,

10:

firstDraftDomain.PullingDirection 10, -5, 10

Note

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

o Sub SetVolumeSupport(Reference iVolumeSupport)

Value the support of draft.

Parameters:

iVolumeSupport

Note

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

o Func Item(CATVariant iIndex) As DraftDomain

Returns a draft domain using its index or its name from the DraftDomains

collection.

Parameters:

iIndex

The index or the name of the draft domain to retrieve from the

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

domain in the collection. The index of the first draft domain in the collection

is 1, and the index of the last draft domain is Count. As a string, it is the

name you assigned to the draft domain using the

AnyObject.Name property.

Returns:

The retrieved draft domain

Example:

The following example returns in domain the third draft domain of

the firstDraftDomains collection:

Set domain = firstDraftDomains.Item(3)

Note

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

o Sub AddEdgeToKeep(Reference iEdgeToKeep)

Adds a new edge to keep by the filleting operation. The edge to keep is not

modified by the fillet.

Parameters:

iEdgeToKeep

The edge to keep by the filleting operation

The following

Boundary object is supported: TriDimFeatEdge.

Example:

The following example adds the new edge edge to be kept from filleting by

the constant radius edge fillet firstCstEdgeFillet:

firstCstEdgeFillet.AddEdgeToKeep(edge)

Note

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

o Property EdgePropagation() As CatFilletEdgePropagation

Returns or sets the edge fillet propagation mode. This propagation mode is

used when computing the edges to be filleted.

Example:

The following example returns in mode the edge fillet propagation mode

of the firstEdgeFillet edge fillet, and then sets it to

CATMinimalFilletEdgePropagation, so that a minimum numbers of edges will be

filleted:

Set mode = firstEdgeFillet.EdgePropagation

Set firstEdgeFillet.EdgePropagation = CATMinimalFilletEdgePropagation

Note

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

o Property EdgesToKeep() As References (Read Only)

Returns the collection of edges to keep by the edge

fillet.

Example:

The following example returns in edges the edges to keep of the

constant radius edge fillet firstCstEdgeFillet:

Set edges = firstCstEdgeFillet.EdgesToKeep

Note

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

o Sub WithdrawEdgeToKeep(Reference iEdgeToWithdraw)

Withdraws an edge from those kept by a filleting

operation.

Parameters:

iEdgeToWithdraw

The edge to withdraw

The following

Boundary object is supported: TriDimFeatEdge.

Example:

The following example withdraws the edge edge from those kept from

filleting by the constant radius edge fillet

firstCstEdgeFillet:

firstCstEdgeFillet.WithdrawEdgeToKeep(edge)

Note

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

o Property FirstFace() As Reference

Returns or sets the first limiting face.

To set the property, you can use the following Boundary object:

Face.

Example:

The following example returns in face1 the first limiting face of the

face fillet firstFaceFillet, and then sets it to

NewFace1:

Set face1 = firstFaceFillet.FirstFace

firstFaceFillet.FirstFace = NewFace1

Note

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

o Property Radius() As Length (Read Only)

Returns the face fillet radius.

Example:

The following example returns in radius the fillet radius of the face

fillet firstFaceFillet:

Set radius = firstFaceFillet.Radius

Note

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

o Property SecondFace() As Reference

Returns or sets the second limiting face.

To set the property, you can use the following Boundary object:

Face.

Example:

The following example returns in face2 the second limiting face of the

face fillet firstFaceFillet, and then sets it to

NewFace2:

Set face2 = firstFaceFillet.SecondFace

firstFaceFillet.SecondFace = NewFace2

Note

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

o Property FilletBoundaryRelimitation() As

CatFilletBoundaryRelimitation

Returns or sets the fillet boundary relimitation mode. This boundary

relimitation mode is used when computing the fillet.

Example:

The following example returns in mode the fillet boundary relimitation

mode of the firstFillet fillet, and then sets it to

catMinimumFilletBoundaryRelimitation, so that the fillet expands up to the

limits of the smallest shell:

Set mode = firstFillet.FilletBoundaryRelimitation

Set FirstFillet.FilletBoundaryRelimitation = catMinimumFilletBoundaryRelimitation

Note

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

o Property FilletTrimSupport() As CatFilletTrimSupport

Returns or sets the fillet Trim Support mode. This Trim Support mode is

used when computing the fillet.

Example:

The following example returns in mode the fillet Trim Support mode of

the firstFillet fillet, and then sets it to catMinimumFilletTrimSupport, so

that the fillet expands up to the limits of the smallest

shell:

Set mode = firstFillet.FilletTrimSupport

Set FirstFillet.FilletTrimSupport = catNoTrimFilletSupport

Note

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

o Property AnchorMode() As CatHoleAnchorMode

Returns the hole anchor mode.

This information is pertinent when hole type is Counterbored or

Counterdrilled only.

Returns:

oMode The hole anchor mode (see CatHoleAnchorMode for list of possible

types)

Example:

The following example returns in holeAnchorMode the anchor mode of

hole firstHole:

Set holeAnchorMode = firstHole.AnchorMode

Note

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

o Property BottomAngle() As Angle (Read Only)

Returns the hole bottom angle.

This call is valid when the hole bottom type is : VBottom.

Returns:

oBottomAngle An Angle object controlling the hole bottom angle (see

Angle for more information)

Example:

The following example returns in holeBottomAngle the bottom angle

of hole firstHole:

Set holeBottomAngle = firstHole.BottomAngle

Note

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

o Property BottomLimit() As Limit (Read Only)

Returns the bottom limit.

This call is valid when the hole bottom type is : BlindHole or ThruHole.

Returns:

oBottomLimit A Limit object controlling the hole bottom limit (see

Limit for more information)

Example:

The following example returns in holeBottomLimit the bottom limit

of hole firstHole:

Set holeBottomLimit = firstHole.BottomLimit

Note

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

o Property BottomType() As CatHoleBottomType

Returns the hole bottom type.

Returns:

oBottomType The hole bottom type (see CatHoleBottomType for list of

possible types)

Example:

The following example returns in holeBottomType the bottom type of

hole firstHole:

Set holeBottomType = firstHole.BottomType

Note

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

o Property CounterSunkMode() As CatCSHoleMode

Returns the mode of a countersunk hole .

Returns:

CSMode Value of the countersunk mode (see CatCSHoleMode for list of

possible types)

Example:

The following example returns in CSMode the CSMode of hole

firsthole:

Set CSMode = firsthole.CounterSunkMode

Note

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

o Sub CreateStandardThreadDesignTable(CatHoleThreadStandard

iStandardType)

Creates a Standard Thread design table .

This call is valid when the hole threading mode is : CATThreadedHoleThreading.

Parameters:

iStandardType

Standard type for thread (see

CatHoleThreadStandard for list of possible types)

Example:

The following example creates a standard table for MetricThinPitch

for hole firstHole:

firstHole.CreateStandardThreadDesignTable

catHoleMetricThinPitch

Note

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

o Sub CreateUserStandardDesignTable(CATBSTR iStandardName,

CATBSTR iPath)

Creates a UserStandard Thread design table .

This call is valid when the hole threading mode is : CATThreadedHoleThreading.

Parameters:

iStandardName

Name of the UserStandard thread. iStandardName should be empty if

filepath is to be defined.

iPath

Path of the UserStandard file. iPath is empty if the filepath is

already defined through CATReffilesPath.

Example1:

The following example creates a standard table for UserStandard

for hole firstHole. The file path is already defined thru

CATReffilesPath:

firstHole.CreateUserStandardDesignTable

“UserStandard”,”“

Example2:

The following example creates a standard table for UserStandard

for hole firstHole when file path is not defined thru

CATReffilesPath:

firstHole.CreateUserStandardDesignTable

“”,”E://user//standard//UserStandard.txt”

Note

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

o Property Diameter() As Length (Read Only)

Returns the hole diameter.

Returns:

oDiameter A Length object controlling the hole diameter (see Length for

more information)

Example:

The following example returns in holeDiam the diameter of hole

firstHole:

Set holeDiam = firstHole.Diameter

Note

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

o Sub GetDirection(CATSafeArrayVariant ioDirection)

Returns the hole direction with absolute coordinates.

It provides a safe array with 3 elements : X, Y, Z direction coordinates

Returns:

oDirection The direction coordinates

Example:

The following example returns in dirArray the direction coordinates

of hole firstHole:

Call firstHole.GetDirection dirArray

Set x = dirArray[1]

Set y = dirArray[2]

Set z = dirArray[3]

Note

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

o Sub GetOrigin(CATSafeArrayVariant ioOrigin)

Returns the origin point which the hole is anchored to.

This point belongs to a tangent plane.

Returns:

oOrigin A Safe Array made up of 3 doubles : X, Y, Z - Hole origin point coordinates

Example:

The following example returns in coordArray the coordinates of hole

firstHole:

Call firstHole.GetOrigin coordArray

Set x = coordArray[1]

Set y = coordArray[2]

Set z = coordArray[3]

Note

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

o Property HeadAngle() As Angle (Read Only)

Returns the hole head angle.

This call is valid when the hole type is : Tapered or Counterdrilled or Countersunk.

Returns:

oHeadAngle An Angle object controlling the hole head angle (see Angle

for more information)

Example:

The following example returns in holeHeadAngle the head angle of

hole firstHole:

Set holeHeadAngle = firstHole.HeadAngle

Note

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

o Property HeadDepth() As Length (Read Only)

Returns the hole head depth.

This call is valid when the hole type is : Counterbored or Counterdrilled or Countersunk.

Returns:

oHeadDepth A Length object controlling the hole head depth (see Length

for more information)

Example:

The following example returns in holeHeadDepth the head depth of

hole firstHole:

Set holeHeadDepth = firstHole.HeadDepth

Note

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

o Property HeadDiameter() As Length (Read Only)

Returns the hole head diameter.

This call is valid when the hole type is : Counterbored or Counterdrilled.

Returns:

oHeadDiameter A Length object controlling the hole head diameter (see

Length for more information)

Example:

The following example returns in holeHeadDiam the head diameter of

hole firstHole:

Set holeHeadDiam = firstHole.HeadDiameter

Note

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

o Property HoleThreadDescription() As StrParam (Read Only)

Returns the hole thread description parameter. This call is valid when the hole threading mode is:

CATThreadedHoleThreading.

This call is valid only when a standard/user design table

exists

Returns:

oThreadDescParam A Parameter object controlling the hole thread

description (see StrParam for more information)

Example:

The following example returns in holeThreadDescription the thread

description (M12 etc) of hole firstHole:

Set holeThreadDescription = firstHole.HoleThreadDescription

Note

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

o Sub Reverse()

Reverses the hole direction .

Example:

The following example reverses the current direction of hole

firstHole:

firstHole.Reverse()

Note

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

o Sub SetDirection(Reference iDirection)

Sets the hole associative direction.

Parameters:

iDirection

A Reference object to an edge or a line (see

Reference for more information)

The following Boundary objects are supported:

RectilinearTriDimFeatEdge, RectilinearBiDimFeatEdge and

RectilinearMonoDimFeatEdge.

Example:

The following example sets the support direction of hole firstHole

with holeDirRef direction reference :

firstHole.SetDirection holeDirref

Note

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

o Sub SetOrigin(double iX,

double iY,

double iZ)

Sets the origin point which the hole is anchored to.

If mandatory, the entry point will be projected onto a tangent

plane.

Parameters:

iX

Origin point x absolute coordinate

iY

Origin point y absolute coordinate

iZ

Origin point z absolute coordinate

Example:

The following example sets the coordinates of hole firstHole to

10., 20., -5. :

firstHole.SetOrigin 10., 20., 5.

Note

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

o Property ThreadDepth() As Length (Read Only)

Returns the hole thread depth.

This call is valid when the hole threading mode is : CATThreadedHoleThreading.

Returns:

oThreadDepth A Length object controlling the hole thread depth (see

Length for more information)

Example:

The following example returns in holeThreadDepth the thread depth

of hole firstHole:

Set holeThreadDepth = firstHole.ThreadDepth

Note

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

o Property ThreadDiameter() As Length (Read Only)

Returns the hole thread diameter.

This call is valid when the hole threading mode is : CATThreadedHoleThreading.

Returns:

oThreadDiameter A Length object controlling the hole thread diameter

(see Length for more information)

Example:

The following example returns in holeThreadDiameter the thread

diameter of hole firstHole:

Set holeThreadDiameter = firstHole.ThreadDiameter

Note

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

o Property ThreadPitch() As Length (Read Only)

Returns the hole thread pitch.

This call is valid when the hole threading mode is : CATThreadedHoleThreading.

Returns:

oThreadPitch A Length object controlling the hole thread pitch (see

Length for more information)

Example:

The following example returns in holeThreadPitch the thread pitch

of hole firstHole:

Set holeThreadPitch = firstHole.ThreadPitch

Note

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

o Property ThreadSide() As CatHoleThreadSide

Returns the hole thread side.

Returns:

oThreadSide The hole thread side (see CatHoleThreadSide for list of

possible sides)

Example:

The following example returns in holeThreadSide the thread side of

hole firstHole:

Set holeThreadSide = firstHole.ThreadSide

Note

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

o Property ThreadingMode() As CatHoleThreadingMode

Returns the hole threading mode.

Returns:

oThreadingMode The hole threading mode (see CatHoleThreadingMode for

list of possible types)

Example:

The following example returns in holeThreadingMode the threading

mode of hole firstHole:

Set holeThreadingMode = firstHole.ThreadingMode

Note

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

o Property Type() As CatHoleType

Returns the hole type.

Returns:

oType The hole type (see CatHoleType for list of possible

types)

Example:

The following example returns in holeType the type of hole

firstHole:

Set holeType = firstHole.Type

Note

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

o Property Dimension() As Length (Read Only)

Returns or sets the limit dimension. This property is valid for the offset

limit mode only, that is when CatLimitMode is set to catOffsetLimit .

Note

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

o Property LimitMode() As CatLimitMode

Returns or sets the limit mode.

Note

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

o Property LimitingElement() As Reference

Returns or sets the limiting element. This property is valid when the

limiting object is a surface or a plane, that is when CatLimitMode is set to

catUpToSurfaceLimit and catUpToPlaneLimit.

To set the property, you can use the following Boundary object: Face.

Note

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

o Property Spacing() As Length (Read Only)

Returns the distance between two consecutive shapes along the repartition

direction.

Example:

The following example returns in space1 the spacing distance of the

linear repartition firstRepartition:

Set space1 = firstRepartition.Spacing

Note

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

o Property HybridShape() As HybridShape (Read Only)

Gets the underlying HybridShapeLoft.

Example:

The following example explains how to retrieve the underlying

HybridShape Loft

Dim oHybridShape as AnyObject

Set oHybridShape=oLoft.HybridShape

oHybridShape.SectionCoupling = 2

Note

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

o Property MirroringObject() As AnyObject (Read Only)

Returns the mirroring Object.

Note

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

o Property MirroringPlane() As Reference

Returns or sets the mirroring reference plane. It can be a plane, or a

plane face.

To set the property, you can use the following Boundary object:

PlanarFace.

Example:

The following example returns in ref the mirroring reference plane of

the mirroring firstMirroring, and then sets it to the created

MyRef:

Set ref = firstMirroring.MirroringPlane

Set MyRef = part.CreateReferenceFromGeometry (plane)

firstMirroring.MirroringPlane = MyRef

Note

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

o Sub ActivatePosition(long iPosU,

long iPosV)

Allows user to activate an instance of the pattern.

Parameters:

iPosU

The position of the instance in the U direction

iPosV

The position of the instance in the V direction

Note

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

o Sub DesactivatePosition(long iPosU,

long iPosV)

Allows user to desactivate an instance of the pattern.

Parameters:

iPosU

The position of the instance in the U direction

iPosV

The position of the instance in the V direction

Note

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

o Property ItemToCopy() As AnyObject

Returns or sets the shape to be copied.

Example:

The following example returns in shape the copied shape of the pattern

firstPattern, and then sets it to pad1:

Set shape = firstPattern.ItemToCopy

firstPattern.ItemToCopy = pad1

Note

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

o Property RotationAngle() As Angle (Read Only)

Returns the pattern global rotation angle. The rotation is applied to the

whole pattern, but not to the shapes themselves. The shape to be copied is used

as the rotation center.

Example:

The following example returns in globAng the rotation of pattern

firstPattern:

Set globAng = firstPattern.RotationAngle

Note

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

o Property DirectionOrientation() As CatPrismOrientation

Returns the prism direction orientation.

Returns:

oOrientation The direction orientation (see CatPrismOrientation for

list of possible types)

Example:

The following example saves in dirOrientation the direction

orientation of prism firstPrism, and then sets it so that the direction will be

now inversed :

Set dirOrientation = firstPrism.DirectionOrientation

firstPrism.DirectionOrientation = catInverseOrientation

Note

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

o Property DirectionType() As CatPrismExtrusionDirection

Returns the prism direction type.

Returns:

oDirType The direction type (see CatPrismExtrusionDirection for list of

possible types)

Example:

The following example saves in dirType the direction type of prism

firstPrism, and then sets it so that the direction will be now normal to the

sketch :

Set dirType = firstPrism.DirectionType

firstPrism.DirectionType = catNormalToSketchDirection

Note

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

o Property FirstLimit() As Limit (Read Only)

Returns the first prism limit (one of the two).

This limit manages the way the prism is ended.

Returns:

oFirstLimit The first limit (see Limit for more

information)

Example:

The following example returns in firstLimit the first limit of

prism firstPrism:

Set firstLimit = firstPrism.FirstLimit

Note

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

o Sub GetDirection(CATSafeArrayVariant ioDirection)

Returns the prism direction with absolute coordinates.

It needs a safe array with 3 elements : X, Y, Z direction coordinates The array must be

previously initialized

Returns:

ioDirection The direction coordinates

Example:

The following example returns in dirArray the direction coordinates

of prism firstPrism:

Dim dirArray(2)

Call firstPrism.GetDirection(dirArray)

Set x = dirArray[1]

Set y = dirArray[2]

Set z = dirArray[3]

Note

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

o Property IsSymmetric() As boolean

Returns the prism symmetry flag.

It returns TRUE if the prism is symmetric (from the base sketch), FALSE if

not.

Returns:

oIsSymmetric The symmetry flag as a boolean

Example:

The following example saves in symFlag the symmetry flag of prism

firstPrism, and then sets it so that it will be now symmetric (from the base

sketch) :

Set symFlag = firstPrism.IsSymmetric

firstPrism.IsSymmetric = TRUE

Note

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

o Property IsThin() As boolean

Returns the prism thin flag.

It returns TRUE if the prism is a thin prism , FALSE if

not.

Returns:

oIsThin The thin flag as a boolean

Example:

The following example saves in thinFlag the thin flag of prism

firstPrism, and then sets it so that it will be now thin

:

Set thinFlag = firstPrism.IsThin

firstPrism.IsThin = TRUE

Note

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

o Property MergeEnd() As boolean

Returns the prism merge end flag (for thin prism only).

It returns TRUE if merge ends is required , FALSE if not.

Returns:

oIsMergeEnd The merge end flag as a boolean

Example:

The following example saves in MergeEndFlag the merge end flag of

prism firstPrism, and then sets it so that merge end will be required

:

Set MergeEndFlag = firstPrism.IsMergeEnd

firstPrism.IsMergeEnd = TRUE

Note

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

o Property NeutralFiber() As boolean

Returns the prism neutral fiber flag (for thin prism

only).

It returns TRUE if the prism is a neutral fiber prism , FALSE if

not.

Returns:

oIsNeutralFiber The neutral fiber flag as a boolean

Example:

The following example saves in NeutralFiberFlag the neutral fiber

flag of prism firstPrism, and then sets it so that it will be now neutral fiber

:

Set NeutralFiberFlag = firstPrism.IsNeutralFiber

firstPrism.IsNeutralFiber = TRUE

Note

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

o Sub ReverseInnerSide()

Reverses the prism inner side when the profile is open. This is useful for

finding the shape to reach.

Example:

The following example reverses the current inner side of prism

firstPrism :

firstPrism.ReverseInnerSide

Note

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

o Property SecondLimit() As Limit (Read Only)

Returns the second prism limit (one of the two).

This limit manages the way the prism is ended.

Returns:

oSecondLimit The second limit (see Limit for more

information)

Example:

The following example returns in secondLimit the second limit of

prism firstPrism:

Set secondLimit = firstPrism.SecondLimit

Note

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

o Sub SetDirection(Reference iLine)

Sets the prism associative direction.

Parameters:

iLine

The support direction reference (see

Reference for more information)

This reference can be valuated with a reference to a line or an

edge.

The following Boundary objects are supported: PlanarFace,

RectilinearTriDimFeatEdge and

RectilinearBiDimFeatEdge.

Example:

The following example sets the prism direction reference of prism

firstPrism with prismDirRef line :

firstPrism.SetDirection prismDirRef

Note

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

o Property FirstDirectionRepartition() As LinearRepartition (Read

Only)

Returns the linear repartition along the first direction.

Example:

The following example returns in repart1 the first linear repartition

of the rectangular pattern firstPattern:

Set repart1 = firstPattern.FirstDirectionRepartition

Note

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

o Property FirstDirectionRow() As IntParam (Read Only)

Returns the position of the shape to be copied along the first linear

direction.

Example:

The following example returns in FirstDirPos the position of the shape

to be copied along the first linear direction in the rectangular pattern

firstPattern:

Set FirstDirPos = firstPattern.FirstDirectionRow

Note

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

o Property FirstOrientation() As boolean

Returns or sets whether the pattern is built towards the first direction

orientation.

True if the pattern is built towards the first direction

orientation.

Example:

The following example returns in aligned1 whether the rectangular

pattern firstPattern is built towards the first direction orientation, and then

sets its to True:

Set aligned1 = firstPattern.FirstOrientation

firstPattern.FirstOrientation = True

Note

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

o Property FirstRectangularPatternParameters() As

CatRectangularPatternParameters

Returns or sets the rectangular pattern parameters required to define the

pattern. These parameters are used when reading the CATIALinearRepartition

properties.

Example:

The following example returns in parameters the rectangular pattern

parameters of the firstPattern rectangular pattern, and then sets it to

catUnequalSpacing, so that the unqual spacing will be defined in first

direction:

Set parameters = firstPattern.FirstCircularPatternParameters

Set firstPattern.FirstCircularPatternParameters = catUnequalSpacing