hybrid_shape_interfaces¶

Note

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

o Property CornerRadiusValue() As Length

Returns or sets the Corner Radius Value.

Note

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

o Property CornerTensionValue() As double

Returns or sets the Corner Tension Value.

Note

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

o Property CurveToOffset() As Reference

Returns or sets the curve to offset.

Note

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

o Property Direction() As HybridShapeDirection

Returns or sets the direction.

Note

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

o Property InvertDirection() As boolean

Returns or sets the direction orientation.

Note

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

o Property OffsetValue() As Length

Returns or sets the OffsetValue.

Note

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

o Property AxisFirstDirection() As Reference

Returns or sets the first direction of the reference coordinate

system.

Sub-element(s) supported (see Boundary object): RectilinearTriDimFeatEdge,

RectilinearBiDimFeatEdge or RectilinearMonoDimFeatEdge.

Example:

This example retrieves in FirstDir the first direction of the reference

coordinate system used by the Affinity hybrid shape

feature.

Dim FirstDir As Reference

Set FirstDir = Affinity.AxisFirstDirection

Note

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

o Property AxisOrigin() As Reference

Returns or sets the origin of the reference coordinate

system.

Sub-element(s) supported (see Boundary object): Vertex.

Example:

This example retrieves in Origin the origin of the reference coordinate

system used by the Affinity hybrid shape feature.

Dim Origin As Reference

Set Origin = Affinity.AxisOrigin

Note

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

o Property AxisPlane() As Reference

Returns or sets the reference plane of the reference coordinate

system.

Sub-element(s) supported (see Boundary object):

PlanarFace.

Example:

This example retrieves in RefPlane the reference plane of the reference

coordinate system used by the Affinity hybrid shape

feature.

Dim RefPlane As Reference

Set RefPlane = Affinity.AxisPlane

Note

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

o Property CreationMode() As boolean

Returns or sets the creation mode(creation or

modification).

Legal values: True if the result is a creation feature and False if the

result is a modification feature.

Example:

This example sets that the mode of

the hybShpAffinity hybrid shape affinity to creation

hybShpAffinity.CreationMode = True

Note

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

o Property ElemToTransform() As Reference

Returns or sets the element to transform using the

affinity.

Example:

This example retrieves in ElementToTransform the element to transform

for the Affinity hybrid shape feature.

Dim ElementToTransform As Reference

Set ElementToTransform = Affinity.ElemToTransform

Note

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

o Property VolumeResult() As boolean

Returns or sets the volume result.

Legal values: True if the result of affinity is required as volume (option

is effective only in case of volumes,requires GSO License) and False if it is

needed as surface .

Example:

This example sets that the result of

the hybShpAffinity hybrid shape affinity is volume.

hybShpAffinity.VolumeResult = True

Note

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

o Property XRatios() As RealParam (Read Only)

Returns the affinity ratio along the X Direction of the reference

coordinate system.

Example:

This example retrieves in X the ratio of the affinity along the X

Direction of the reference coordinate system used by the Affinity hybrid shape

feature.

Dim X As RealParam

Set X = Affinity.XRatios

Note

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

o Property YRatios() As RealParam (Read Only)

Returns the affinity ratio along the Y Direction of the reference

coordinate system.

Example:

This example retrieves in Y the ratio of the affinity along the Y

Direction of the reference coordinate system used by the Affinity hybrid shape

feature.

Dim Y As RealParam

Set Y = Affinity.YRatios

Note

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

o Property ZRatios() As RealParam (Read Only)

Returns the affinity ratio along the Z Direction of the reference

coordinate system.

Example:

This example retrieves in Z the ratio of the affinity along the Z

Direction of the reference coordinate system used by the Affinity hybrid shape

feature.

Dim Z As RealParam

Set Z = Affinity.ZRatios

Note

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

o Sub AddElement(Reference iElement)

Adds an element to the hybrid shape assemble feature

object.

Parameters:

iElement

The element to add to the hybrid shape assemble feature

object.

Sub-element(s) supported (see

Boundary object): Face, TriDimFeatEdge and BiDimFeatEdge.

Examples:

The following example adds the iElement feature object to the

HybridShapeAssemble object.

HybridShapeAssemble.AddElement iElement

Note

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

o Sub AddSubElement(Reference iSubElement)

Adds a sub element to the hybrid shape assemble feature

object.

Parameters:

iSubElement

The sub element to remove to the hybrid shape assemble feature

object.

Note

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

o Sub AppendFederatedElement(Reference iElement)

Appends an init to the list of elements to federate.

Parameters:

iElement

Element to append.

See also:

Reference

Note

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

o Func GetAngularTolerance() As double

Get the angular tolerance.

Parameters:

oValue

The angular tolerance.

Note

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

o Func GetAngularToleranceMode() As boolean

Get the angular tolerance mode.

Parameters:

oValue

The angular tolerance mode.

Note

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

o Func GetConnex() As boolean

Get the connex checker flag.

Parameters:

oConnex

Note

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

o Func GetDeviation() As double

Get the deviation value.

Parameters:

odeviation

The deviation.

Note

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

o Func GetElement(long iRank) As Reference

Retrieves an element used by the hybrid shape assemble feature

object.

Parameters:

iRank

The rank of the element to read.

Examples:

The following example gets the oElement feature object of the

HybridShapeAssemble object at the position iRank.

Dim oElement As Reference

Set oElement = HybridShapeAssemble.GetElement (iRank).

Note

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

o Func GetElementsSize() As long

Returns the size of the list of elements to assemble in the hybrid shape

assemble feature object.

Parameters:

oSize

Number of elements in the Assemble.

Example:

This example retrieves the number of elements in the

HybShpAssemble hybrid shape assemble.

Dim oSize As long

oSize = HybShpAssemble.GetElementsSize

Note

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

o Func GetFederatedElement(long iRank) As Reference

Retrieves an federated inits used by the hybrid shape assemble feature

object.

Parameters:

iRank

The rank of the element to read.

oElement

The federated element.

See also:

Reference

Note

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

o Func GetFederatedElementsSize() As long

Gets the number of federated inits.

Parameters:

Size

Number of elements.

Note

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

o Func GetFederationPropagation() As long

Gets the propagation mode of the federation.

Parameters:

i

type of propagation (0: No, 1: All, 2: Continuity,

3:Tangency).

Note

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

o Func GetManifold() As boolean

Get the manifold checker flag.

Parameters:

oManifold

Note

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

o Func GetSimplify() As boolean

Get the simplify flag.

Parameters:

oSimplify

Note

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

o Func GetSubElement(long iRank) As Reference

Retrieves a sub element used by the hybrid shape assemble feature

object.

Parameters:

iRank

The rank of the subelement to read.

Note

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

o Func GetSubElementsSize() As long

Returns the size of the list of sub-elements to remove in the hybrid shape

assemble feature object.

Parameters:

oSize

Number of sub elements in the Assemble.

Example:

This example retrieves the number of sub elements in the

HybShpAssemble hybrid shape assemble.

Dim oSize As long

oSize = HybShpAssemble.GetSubElementsSize

Note

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

o Func GetSuppressMode() As boolean

Get the SuppressMode flag.

Parameters:

oSuppressMode

Note

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

o Func GetTangencyContinuity() As boolean

Get the tangency continuity checker flag.

Parameters:

oTangencyContinuity

Note

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

o Property Invert() As boolean

Returns or sets the invert mode.

Legal values: True the result is inverted. False the result is not

inverted.

Example:

This example sets the invert mode of

the HybShpAssemble hybrid shape assemble feature to

True.

HybShpAssemble.Invert = True

Note

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

o Sub RemoveElement(long iRank)

Removes an element used by the hybrid shape assemble feature

object.

Parameters:

iRank

The rank of the element to remove.

Examples:

The following example removes the feature object from the

HybridShapeAssemble object at the position iRank.

HybridShapeAssemble.RemoveElement iRank.

Note

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

o Sub RemoveFederatedElement(long iRank)

Removes an element to the list of elements to federate.

Parameters:

iRank

Position of the element to remove.

Note

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

o Sub RemoveSubElement(long iRank)

Removes a sub element used by the hybrid shape assemble feature

object.

Parameters:

iRank

The rank of the element to remove.

Note

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

o Sub ReplaceElement(long iPos,

Reference iElement)

Replaces the element at specified position in the hybrid shape assemble

feature object.

Parameters:

iPos

Position at which the element should be replaced.

iElement

Reference of the element to be inserted.

Example:

This example replaces the element in the HybShpAssemble

assemble feature at specified position iPos

HybShpAssemble.ReplaceElement iPos,iElement

Note

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

o Sub SetAngularTolerance(double iValue)

Set the angular tolerance.

Parameters:

iValue

The angular tolerance.

Note

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

o Sub SetAngularToleranceMode(boolean iValue)

Set the angular tolerance mode.

Parameters:

iValue

The angular tolerance mode.

Note

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

o Sub SetConnex(boolean iConnex)

Set the connex checker flag.

Parameters:

iConnex

Note

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

o Sub SetDeviation(double ideviation)

Set the deviation value.

Parameters:

ideviation

The deviation.

Note

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

o Sub SetFederationPropagation(long iMode)

Sets the propagation mode of federation.

Parameters:

i

type of propagation (0: No, 1: All, 2: Continuity,

3:Tangency).

Note

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

o Sub SetManifold(boolean iManifold)

Set the manifold checker flag.

Parameters:

iManifold

Note

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

o Sub SetSimplify(boolean iSimplify)

Set the simplify flag.

Parameters:

iSimplify

Note

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

o Sub SetSuppressMode(boolean iSuppressMode)

Set the SuppressMode flag.

Parameters:

iSuppressMode

Note

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

o Sub SetTangencyContinuity(boolean iTangencyContinuity)

Set the tangency continuity checker flag.

Parameters:

iTangencyContinuity

Note

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

o Property AxisLineType() As long

Returns or sets the axis line type.

Legal values:

1

This option creates Axis along major axis if element is ellipse or

oblong, Axis is aligned with direction specified if input is circle and

coincides with revolution axis if element is revolution

surface

2

This option creates Axis along minor axis if element is ellipse or

oblong, Axis is normal to direction specified if input is

circle

3

This option creates Axis normal to the element if it is circle, ellipse

or oblong

Example:

This example retrieves in oType the axis line type for the AxisLine hybrid

shape feature.

Dim oType

Set oType = AxisLine.AxisLineType

Note

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

o Property Direction() As HybridShapeDirection

Gets the reference direction used in computation of axis.

This is useful only if the element selected is circle, arc or sphere. If

the element is circle or arc Axis may be normal to reference direction or

aligned with reference direction

Example:

This example retrieves in oDir the direction for the AxisLine hybrid

shape feature.

Dim oDir As CATIAHybridShapeDirection

Set oDir = AxisLine.Direction

Note

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

o Property Element() As Reference

Returns or sets the element from which axis is computed.

Example:

This example retrieves in Element the element from which axis is

computed for the AxisLine hybrid shape feature.

Dim Element As Reference

Set Element = AxisLine.Element

Note

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

o Property CreationMode() As boolean

Returns or sets the creation mode(creation or

modification).

Legal values: True if the result is a creation feature and False if the

result is a modification feature.

Example:

This example sets that the mode of

the hybShpAxisToAxis hybrid shape axis to axis to

creation

hybShpAxisToAxis.CreationMode = True

Note

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

o Property ElemToTransform() As Reference

Returns or sets the element to transform.

Example:

This example retrieves in Elem the element to transform for the

AxisToAxis hybrid shape feature.

Dim Elem As Reference

Set Elem = AxisToAxis.ElemToTransform

Note

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

o Property ReferenceAxis() As Reference

Returns or sets the reference axis.

Example:

This example retrieves in Ref the reference axis for the AxisToAxis

hybrid shape feature.

Dim Ref As Reference

Set Ref = AxisToAxis.ReferenceAxis

Note

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

o Property TargetAxis() As Reference

Returns or sets the target axis.

Example:

This example retrieves in Ref the target axis for the AxisToAxis hybrid

shape feature.

Dim Ref As Reference

Set Ref = AxisToAxis.ReferenceAxis

Note

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

o Property VolumeResult() As boolean

Returns or sets the volume result.

Legal values: True if the result of axis to axis transformation is required

as volume (option is effective only in case of volumes,requires GSO License))

and False if it is needed as surface .

Example:

This example sets that the result of

the hybShpAxisToAxis hybrid shape AxisToAxis is

volume.

hybShpAxisToAxis.VolumeResult = True

Note

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

o Property Coupling() As long

Returns or sets the type of coupling between the limits of the

blend.

Legal values: The values representing the type of coupling can

be:

1

Ratio: the curves are coupled according to the curvilinear abscissa

ratio

2

Tangency: the curves are coupled according to their tangency

discontinuity points. If they do not have the same number of tangency

discontinuity points, they cannot be coupled and an error message is displayed

3

Tangency then curvature: the curves are coupled according to their

tangency discontinuity points first, then according to their curvature

discontinuity points. If they do not have the same number of tangency and

curvature discontinuity points, they cannot be coupled and an error message is

displayed

4

Vertices: the curves are coupled according to their vertices. If they

do not have the same number of vertices, they cannot be coupled and an error

message is displayed

5

Spine: coupling is completely driven by a curve (called spine)

Example:

This example retrieves in CouplingVal the coupling value of the

ShpBlend hybrid shape blended feature.

CouplingVal = ShpBlend.Coupling

Note

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

o Func GetBorderMode(long iBlendLimit) As long

Returns the type of border to a limit of the blend.

Parameters:

iBlendLimit

The limit of the blend whose type of border is to be

retrieved.

Legal values: 1 for the first limit, and 2 for the second one

Returns:

The type of border

Legal values:

1

The border of the blend will be tangent to the border of the

support surface, or if the curve ends on the border of a face of the support

surface, then the border of the blend will be tangent to the border face.

2

The border of the blend is not constrained.

Example:

This example retrieves in BorderType the type of border of the first limit

of the ShpBlend hybrid shape blended feature.

BorderType = ShpBlend.GetBorderMode(1)

Note

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

o Func GetClosingPoint(long iBlendLimit) As Reference

Returns the closing point of a closed curve of the blend.

Parameters:

iBlendLimit

The limit of the blend whose curve closing point is

returned.

Legal values: 1 for the first curve, and 2 for the second one

Returns:

The retrieved closing point

Example:

This example retrieves in ClosingPoint the closing point of the curve of

the second limit of the ShpBlend hybrid shape blended

feature.

Dim ClosingPoint As Reference

ClosingPoint = ShpBlend.GetClosingPoint(2)

Note

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

o Func GetContinuity(long iBlendLimit) As long

Retrieves the continuity of a limit of the blend.

Parameters:

iBlendLimit

The limit of the blend whose continuity is to be

retrieved.

Legal values: 1 for the first limit, and 2 for the second one

Returns:

The retrieved continuity.

Legal values:

0

Point continuity

1

Tangency continuity

2

Curvature continuity

Example:

This example retrieves in Continuity the continuity of the second limit of

the ShpBlend hybrid shape blended feature.

Continuity = ShpBlend.GetContinuity(2)

Note

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

o Func GetCurve(long iBlendLimit) As Reference

Returns a curve from the blend.

Parameters:

iBlendLimit

The limit of the blend from which the curve will be

retrieved.

Legal values: 1 for the first curve, and 2 for the second one

Returns:

The retrieved curve

Example:

This example retrieves in BlendCurve the curve of the second limit of the

ShpBlend hybrid shape blended feature.

Dim BlendCurve As Reference

BlendCurve = ShpBlend.GetCurve(2)

Note

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

o Func GetOrientation(long iBlendLimit) As long

Returns the orientation of a curve of the blend.

Parameters:

iBlendLimit

The limit of the blend whose curve orientation is to be

retrieved.

Legal values: 1 for the first curve, and 2 for the second one

Returns:

The orientation to set to the curve.

Legal values: 1 for direct and -1 for reverse

Example:

This example retrieves in Orientation the orientation of the second limit

of the ShpBlend hybrid shape blended feature.

Orientation = ShpBlend.GetOrientation(2)

Note

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

o Func GetRuledDevelopableSurfaceConnection(long iBlendLimit) As

long

Returns or sets the ruled developable surface connection

type.

Parameters:

iBlendLimit

The limit of the blend for which the connection type is to be

set.

Legal values: 1 for the start limit, and 2 for the end one

oBlendConnection

The value of connection type

Legal values:

1

Connect to both extremities

2

Free first curve

3

Free second curve

Note

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

o Func GetSupport(long iBlendLimit) As Reference

Returns a support from the blend.

Parameters:

iBlendLimit

The limit of the blend whose support is to be

retrieved.

Legal values: 1 for the first support, and 2 for the second one

Returns:

The retrieved support surface

Example:

This example retrieves in SupportSurf the support surface of the second

limit of the ShpBlend hybrid shape blended feature.

Dim SupportSurf As Reference

SupportSurf = ShpBlend.GetSupport(2)

Note

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

o Func GetTensionInDouble(long iBlendLimit,

long iRank) As RealParam

Returns the tension values of a limit of the blend.

Parameters:

iBlendLimit

The limit of the blend from which the tension type and values are

to be retrieved.

Legal values: 1 for the first limit, and 2 for the second one

iRank

The rank of the value to retrieve among those available, depending

on the tension type.

Legal values: iRank can take the following values:

1

With default tension and constant tension, for the unique

available value, and with linear tension for the first value

2

With linear tension for the second value

Returns:

The retrieved tension value

Example:

This example retrieves in TensionVal the tension value of the tension,

supposed to be a constant tension, of the first limit of the ShpBlend hybrid

shape blended feature.

Dim ConstTensionVal As RealParam

Set ConstTensionVal = ShpBlend.GetTensionInDouble(1, 1)

Note

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

o Func GetTensionType(long iBlendLimit) As long

Returns the tension type of a limit of the blend.

Parameters:

iBlendLimit

The limit of the blend from which the tension type is to be

retrieved.

Legal values: 1 for the first limit, and 2 for the second one

Returns:

The value of tension type

Legal values:

1

Default tension

2

Constant tension

3

Linear tension

Example:

This example retrieves in TensionType the tension type of the first limit

of the ShpBlend hybrid shape blended feature.

TensionType.GetTensionType(1)

Note

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

o Func GetTransition(long iBlendLimit) As long

Returns the transition orientation from a limit of the

blend.

Let T be the tangent to the wire, and N be the normal to the skin body. The

transition orientation defines how the blend goes from the initial wires: it

takes the direction of iTransition*(T^N), where ^ is the cross

product.

Parameters:

iBlendLimit

The limit of the blend whose transition orientation is to be

retrieved.

Legal values: 1 for the first support, and 2 for the second one

Returns:

The retrieved value of transition orientation.

Legal values: 1 for direct and -1 for reverse

Example:

This example retrieves in TransOrientation the transition orientation of

the second limit of the ShpBlend hybrid shape blended

feature.

TransOrientation = ShpBlend.GetTransition(2)

Note

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

o Func GetTrimSupport(long iBlendLimit) As long

Returns whether a support of the blend will be trimmed

off.

If the support is set to be trimmed, it will be trimmed using the curve

then joined to the blend.

Parameters:

iBlendLimit

The limit of the blend whose support is to be

trimmed.

Legal values: 1 for the first limit, and 2 for the second one

Returns:

The trim support mode

Legal values:

1

No trim

2

The support will be trimmed

Example:

This example retrieves whether the second limit of the ShpBlend hybrid

shape blended feature should be trimmed off.

IsTrimmed = ShpBlend.GetTrimSupport(2)

Note

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

o Sub InsertCoupling(long iPosition)

Inserts a coupling into the blend.

Parameters:

iPosition

The position of the coupling in the list of couplings. Setting

iPosition to 0 inserts the coupling at the end of the list.

Example:

This example inserts a coupling at the end of the coupling list of the

ShpBlend hybrid shape blended feature.

ShpBlend.InsertCouplingt 0

Note

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

o Sub InsertCouplingPoint(long iCouplingIndex,

long iPosition,

Reference iPoint)

Inserts a coupling point to a coupling of the blend.

Parameters:

iCouplingIndex

The index of the coupling in the list of couplings into which the

coupling point will be inserted.

iPosition

The position of the coupling point in the list of coupling points.

Setting iPosition to 0 inserts the coupling point at the end of the list.

iPoint

The coupling point to be inserted. This point must lay on the

section with the same position.

Sub-element(s) supported (see

Boundary object): Vertex.

Example:

This example inserts the Point23 point into the third coupling at the end

of the list of coupling points of the ShpBlend hybrid shape blended

feature.

ShpBlend.InsertCouplingPoint 3, 0, Point23

Note

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

o Property RuledDevelopableSurface() As boolean

Returns or sets the ruled developable surface mode.

TRUE means that the mode is enabled and FALSE means that it is disabled.

Note

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

o Sub SetBorderMode(long iBlendLimit,

long iBorder)

Sets the type of border to a limit of the blend.

Parameters:

iBlendLimit

The limit of the blend whose type of border is to be

set.

Legal values: 1 for the first limit, and 2 for the second one

iBorder

The type of border

Legal values:

1

The border of the blend will be tangent to the border of the

support surface, or if the curve ends on the border of a face of the support

surface, then the border of the blend will be tangent to the border face.

2

The border of the blend is not constrained.

3

The border of the blend will be tangent to the border of the

support surface at the start extremity of the curve, or if the curve ends on

the border of a face of the support surface, then the border of the blend will

be tangent to the border face at the start extremity of the curve.

4

The border of the blend will be tangent to the border of the

support surface at the end extremity of the curve, or if the curve ends on the

border of a face of the support surface, then the border of the blend will be

tangent to the border face at the end extremity of the curve.

Example:

This example sets the type of border of the second limit of the

ShpBlend hybrid shape blended feature to “no

constraint”.

ShpBlend.SetBorderMode 2, 2

Note

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

o Sub SetClosingPoint(long iBlendLimit,

Reference iClosingPoint)

Sets a new closing point to a closed curve of the blend.

Parameters:

iBlendLimit

The limit of the blend whose curve will be set a new closing

point.

Legal values: 1 for the first curve, and 2 for the second one

iClosingPoint

The closing point to be set. This point must lay on the curve of

the blend limit.

Sub-element(s) supported (see

Boundary object): Vertex.

Example:

This example sets the Point10 point as the closing point to the second

limit of the ShpBlend hybrid shape blended feature.

ShpBlend.SetClosingPoint 2, Point10

Note

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

o Sub SetContinuity(long iBlendLimit,

long iContinuity)

Sets the continuity to a limit of the blend.

Parameters:

iBlendLimit

The limit of the blend whose continuity is to be

set.

Legal values: 1 for the first limit, and 2 for the second one

iContinuity

The continuity to set

Legal values:

0

Point continuity

1

Tangency continuity

2

Curvature continuity

Example:

This example sets the continuity of the second limit of the ShpBlend

hybrid shape blended feature to tangency continuity.

ShpBlend.SetContinuity 2, 1

Note

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

o Sub SetCurve(long iBlendLimit,

Reference iCurve)

Sets a curve to the blend.

Parameters:

iBlendLimit

The limit of the blend to which the curve will be

set.

Legal values: 1 for the first curve, and 2 for the second one

iCurve

The curve to be set.

Sub-element(s) supported (see

Boundary object): TriDimFeatEdge and BiDimFeatEdge.

Example:

This example sets the CurveForBlend curve to the second limit of the

ShpBlend hybrid shape blended feature.

ShpBlend.SetCurve 2, CurveForBlend

Note

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

o Sub SetOrientation(long iBlendLimit,

long iOrientation)

Sets the orientation of a curve of the blend.

Parameters:

iBlendLimit

The limit of the blend whose curve orientation is to be

set.

Legal values: 1 for the first curve, and 2 for the second one

iOrientation

The orientation to set to the curve.

Legal values: 1 for direct and -1 for reverse

Example:

This example sets the orientation of the second limit of the ShpBlend

hybrid shape blended feature to direct.

ShpBlend.SetOrientation 2, 1

Note

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

o Sub SetRuledDevelopableSurfaceConnection(long iBlendLimit,

long iBlendConnection)

Note

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

o Sub SetSmoothAngleThreshold(double iAngle)

Sets the angular threshold.

Parameters:

iAngle

The angular threshold

Note

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

o Sub SetSmoothDeviation(double iLength)

Sets the deviation value (length) from guide curves allowed during sweeping

operation in order to smooth it.

Parameters:

iLength

The deviation value

Note

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

o Sub SetSupport(long iBlendLimit,

Reference iSupport)

Sets a support to the blend.

Parameters:

iBlendLimit

The limit of the blend whose support is to be set.

Legal values: 1 for the first support, and 2 for the second one

iSupport

The support surface to be set. The curve of the blend limit must

lay on the surface.

Sub-element(s) supported (see

Boundary object): Face.

Example:

This example sets the SupportSurf surface as the support of the second

limit of the ShpBlend hybrid shape blended feature.

ShpBlend.SetSupport 2, SupportSurf

Note

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

o Sub SetTensionInDouble(long iBlendLimit,

long iTensionType,

double iFirstTension,

double iSecondTension)

Sets the tension values to a limit of the blend. The values must be

expressed as doubles and must be positive.

Parameters:

iBlendLimit

The limit of the blend to which the tension values are to be

set.

Legal values: 1 for the first limit, and 2 for the second one

iTensionType

The tension type

Legal values:

1

Default tension

2

Constant tension

3

Linear tension

iFirstTension

The value for the first tension. It must be used with any tension

type

Legal values: it must be a double and positive.

iSecondTension

The value for the second tension. It can be used with linear

tension only

Legal values: it must be a double and positive.

Example:

This example sets the tension values of the tension, supposed to be a

linear tension, of the first limit of the ShpBlend hybrid shape blended feature

to respectively 1.5 and 0.5.

ShpBlend.SetTensionInDouble 1, 3, 1.5, 0.5

Note

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

o Sub SetTensionType(long iBlendLimit,

long iTensionType)

Sets the tension type of a limit of the blend.

Parameters:

iBlendLimit

The limit of the blend for which the tension type is to be

set.

Legal values: 1 for the first limit, and 2 for the second one

iBlendLimit

The value of tension type

Legal values:

1

Default tension

2

Constant tension

3

Linear tension

4

SType tension

Example:

This example sets the tension type as Default Tension for the first

limit of the ShpBlend hybrid shape blended feature.

ShpBlend.SetTensionType 1, 1

Note

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

o Sub SetTransition(long iBlendLimit,

long iTransition)

Sets the transition orientation to a limit of the blend.

Role: Let T be the tangent to the wire, and N be the normal to the skin

body. The transition orientation defines how the blend goes from the initial

wires: it takes the direction of iTransition*(T^N), where ^ is the cross

product.

Parameters:

iBlendLimit

The limit of the blend whose transition orientation is to be

set.

Legal values: 1 for the first support, and 2 for the second one

iTransition

The value of transition orientation.

Legal values: 1 for direct and -1 for reverse

Example:

This example sets the transition orientation of the second limit of the

ShpBlend hybrid shape blended feature to reverse.

ShpBlend.SetTransition 2, -1

Note

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

o Sub SetTrimSupport(long iBlendLimit,

long iTrimSupport)

Sets whether a support of the blend is to be trimmed off.

If the support is set to be trimmed, it will be trimmed using the curve

then joined to the blend.

Parameters:

iBlendLimit

The limit of the blend whose support is to be

trimmed.

Legal values: 1 for the first limit, and 2 for the second one

iTrimSupport

The trim support mode

Legal values:

1

No trim

2

The support will be trimmed

Example:

This example sets that the second limit of the ShpBlend hybrid shape

blended feature should be trimmed off.

ShpBlend.SetTrimSupport 2, 2

Note

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

o Property SmoothAngleThreshold() As Angle (Read Only)

Returns the angular threshold.

Note

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

o Property SmoothAngleThresholdActivity() As boolean

Returns or sets information whether a blending operation is smoothed or

not.

TRUE if the blending operation is smoothed, or FALSE otherwise (FALSE if

not specified).

Note

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

o Property SmoothDeviation() As Length (Read Only)

Returns the deviation value (length) from guide curves allowed during a

sweeping operation in order to smooth it.

Note

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

o Property SmoothDeviationActivity() As boolean

Returns or sets information whether a deviation from guide curves is

allowed or not.

Gives the information on performing smoothing during blending

operation.

TRUE if a deviation from guide curves is allowed, or FALSE otherwise (FALSE

if not specified).

Note

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

o Property Spine() As Reference

Returns or sets a curve used as spine for coupling in Blend computation.

Setting the spine curve also changes coupling mode to CATGSMSpineCoupling. In

order to remove the spine, set another coupling mode.

Parameters:

iSpine

spine curve

Note

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

o Sub UnsetClosingPoint(long iBlendLimit)

Unsets the closing point of a closed curve of the blend.

Parameters:

iBlendLimit

The limit of the blend whose curve closing point is

unset.

Legal values: 1 for the first curve, and 2 for the second one

Example:

This example unsets the closing point of the second limit of the

ShpBlend hybrid shape blended feature.

ShpBlend.UnsetClosingPoint 2

Note

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

o Sub UnsetSupport(long iBlendLimit)

Unsets a support from the blend.

Parameters:

iBlendLimit

The limit of the blend whose support is to be

unset.

Legal values: 1 for the first support, and 2 for the second one

Example:

This example unsets the support surface of the second limit of the

ShpBlend hybrid shape blended feature.

ShpBlend.UnsetSupport 2

Note

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

o Property FromOrientation() As long

Gets or sets the Ending Limit Orientation (i.e same or inverse)

Note

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

o Property From() As Reference

Removes or sets the ending limit(i.e Limit2) of the boundary

Note

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

o Property InitialElement() As Reference

Returns or sets the element used to initialize the boundary

propagation.

Sub-element(s) supported (see Boundary object):

BiDimFeatEdge.

Example:

This example retrieves in InitElem the initial element of the

ShpBoundary hybrid shape boundary feature.

Dim InitElem As Reference

InitElem = ShpBoundary.InitialElement

Note

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

o Property Propagation() As long

Returns or sets the boundary propagation.

Legal values: xxxxxxxxxx

Example:

This example retrieves in Prop the boundary propagation of the

ShpBoundary hybrid shape boundary feature.

Prop = ShpBoundary.Propagation

Note

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

o Property Support() As Reference

Returns or sets the support surface around which the boundary is

computed.

Sub-element(s) supported (see Boundary object): Face.

Example:

This example retrieves in SupSurf the initial element of the

ShpBoundary hybrid shape boundary feature.

Dim SupSurf As Reference

SupSurf = ShpBoundary.Support

Note

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

o Property To() As Reference

Removes or sets the starting limit(i.e Limit1) of the boundary

Note

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

o Property ToOrientation() As long

Gets or sets the Starting Limit Orientation (i.e same or inverse)

Note

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

o Property BodyToBump() As Reference

Returns or sets the element to Bump.

Note

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

o Property CenterTension() As RealParam

Returns or sets the tension center parameter.

Note

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

o Property ContinuityType() As long

Returns or sets the continuity type ..

Legal values: the continuity type is either

PointContinuity =0

TangentContinuity =1

CurvatureContinuity =2

Note

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

o Property DeformationCenter() As Reference

Returns or sets the Deformation Center.

Note

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

o Property DeformationDir() As Reference

Returns or sets the Deformation Direction.

Note

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

o Property DeformationDist() As Length

Returns the translate distance (CATIA Parameter).

Note: Distance value is set or retrieve trough a Literaql

parameter

Parameters are value are given in the Part Unit

Example : if Part Unit for dimensions is mm: for 1 mmm, oDefDist.Value will return 1.000

Note

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

o Property DeformationDistValue() As double

Returns or sets the Deformation distance (double) .

Note: Distance value is expressed in MKS = Meters

Example to set up 1mm , use .001

Note

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

o Property LimitCurve() As Reference

Returns or sets the limit curve.

Note

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

o Property ProjectionDir() As Reference

Returns or sets the limit curve.

Note

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

o Property AxisComputation() As boolean

Returns or sets the axis computation mode.

Example:

This example retrieves the axis computation mode of

the hybShpCircle

Dim axisComp As Boolean

axisComp = hybShpCircle.AxisComputation

Note

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

o Property AxisDirection() As HybridShapeDirection

Role: To get_Direction on the object.

Parameters:

oDir

return value for CATScript applications, with (IDLRETVAL) function

type

See also:

HybridShapeDirection

Returns:

HRESULT S_OK if Ok E_FAIL else return error code for C++

Implementations

See also:

HybridShapeFactory

Note

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

o Property EndAngle() As Angle (Read Only)

Returns the circle end angle.

Example:

This example retrieves in ShpCircleEndAngle the end angle of the

ShpCircle hybrid shape circle.

Dim ShpCircleEndAngle As Angle

ShpCircleEndAngle = ShpCircle.EndAngle

Note

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

o Sub GetAxis(long iPosition,

Reference oAxis)

Returns the axis of the Circle.

Parameters:

iType

Type of axis to be retrived. 3 - CATGSMAxisLineType_NormalToCircle

2 - CATGSMAxisLineType_NormalToDirection 1 -

CATGSMAxisLineType_AlignedWithDirection

oAxis

Reference to the element.

Example:

This example retrieves the axis of the circle. HybShpCircle

hybrid shape circle.

Dim AxisRef As Reference

HybShpCircle.GetAxis 1, AxisRef

Note

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

o Sub GetCenter(double oCenterX,

double oCenterY,

double oCenterZ)

Gets the mathematical center of the circle. This information is available

once the circle has been computed.

Parameters:

oCenterX,

oCenterY, oCenterZ, circle center

Note

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

o Sub GetFreeCenter(CATSafeArrayVariant ioCenter)

Returns the circle center.

Parameters:

oCenter

The circle center. It is returned as an array of three coordinates

in SafeArrayVariant

Example:

This example retrieves in HybShpCircleCenter the center of the

HybShpCircle hybrid shape circle.

Dim HybShpCircleCenter

ReDim HybShpCircleCenter(2)

ShpCircle.GetFreeRadius(HybShpCircleCenter)

You can access each center coordinate as follows:

x is in HybShpCircleCenter(0)

y is in HybShpCircleCenter(1)

z is in HybShpCircleCenter(2)

Note

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

o Sub GetFreeRadius(double oRadius)

Returns the circle radius.

Parameters:

oRadius

The circle radius

Example:

This example retrieves in HybShpCircleRadius the radius of the

HybShpCircle hybrid shape circle.

double HybShpCircleRadius

ShpCircle.GetFreeRadius(HybShpCircleRadius)

Note

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

o Func GetLimitation() As long

Gets the limitation type for the circle.

Parameters:

oLimit

(Angles = 0, Whole = 1, Trimmed = 2, Complementary = 3). circle limitation

Note

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

o Sub SetLimitation(long iLimitation)

Set the circle limitation type.

Parameters:

iLimitation

The circle limitation type

Legal values:

0

Angles

1

Whole

2

Trimmed

3

Complementary

Example:

This example sets the limitiation type of the ShpCircle hybrid shape

circle to trimmed.

ShpCircle.SetLimitation 2

Note

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

o Property StartAngle() As Angle (Read Only)

Returns the circle start angle.

Example:

This example retrieves in ShpCircleStartAngle the end angle of the

ShpCircle hybrid shape circle.

Dim ShpCircleStartAngle As Angle

ShpCircleStartAngle = ShpCircle.StartAngle

Note

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

o Property Diameter() As Length (Read Only)

Returns the circle diameter. It is expressed as a Length literal. Succeeds

only if DiameterMode is set to True.

Example:

This example retrieves in HybShpCircleDiameter the diameter of the

HybShpCircle hybrid shape circle feature

Dim HybShpCircleDiameter As Length

HybShpCircleDiameter = HybShpCircle.Diameter

Note

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

o Property DiameterMode() As boolean

Returns or sets the DiameterMode.

Legal values: True implies diameter False implies radius (default). When

DiameterMode is changed, Radius/Diameter value, which is stored will not be

modified.

Example:

This example sets that the DiameterMode of

the HybShpCircle hybrid shape circle feature

HybShpCircle.DiameterMode = True

Note

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

o Func IsGeodesic() As boolean

Queries whether the circle is geodesic or not.

Parameters:

oGeod

geodesic type : when TRUE, the circle is geodesic.

Note

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

o Property Orientation() As long

Returns or sets the circle orientation.

Role: The circle orientation indicates which side of the line made up using

the two passing points is used to create the major part of the circle. It is

determined using the cross product of the normal to the suppport and the vector

made up using the two passing points (Pt1-Pt2).

Legal values: 1 to state that the major part of the circle is or should be

created on the side of the line shown by the vector resulting from this cross

product, and -1 otherwise.

Example:

This example retrieves in HybShpCircleOrientation the orientation of

the HybShpCircle hybrid shape circle.

HybShpCircleOrientation = HybShpCircle.Orientation

Note

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

o Property Pt1() As Reference

Returns or sets the circle first passing point.

Sub-element(s) supported (see Boundary object): Vertex.

Example:

This example retrieves the first passing point of the HybShpCircle

hybrid shape circle in HybShpCircleFirstPassingPoint

point.

Dim HybShpCircleFirstPassingPoint As Reference

Set HybShpCircleFirstPassingPoint = HybShpCircle.Pt1

Note

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

o Property Pt2() As Reference

Returns or sets the circle second passing point.

Sub-element(s) supported (see Boundary object): Vertex.

Example:

This example sets the second passing point of the HybShpCircle hybrid

shape circle as the Point12 point.

HybShpCircle.Pt2 Point12

Note

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

o Property Radius() As Length (Read Only)

Returns the circle radius.

Parameters:

Radius

The circle radius, expressed as a

Length literal. Succeeds only if DiameterMode is set to False.

Example:

This example retrieves in HybShpCircleRadius the radius of the HybShpCircle

hybrid shape circle.

Dim HybShpCircleRadius As Length

HybShpCircleRadius = HybShpCircle.Radius

Note

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

o Sub SetGeometryOnSupport()

Sets GeometryOnSupport of circle.

It puts the circle on the surface. S_OK if OK, E_FAIL if fail

Note

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

o Property Support() As Reference

Returns or sets the circle support surface.

Sub-element(s) supported (see Boundary object): Face.

Example:

This example retrieves in HybShpCircleSupportSurf the support surface

of the HybShpCircle hybrid shape circle.

Dim HybShpCircleSupportSurf As Reference

HybShpCircleSupportSurf = HybShpCircle.Support

Note

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

o Sub UnsetGeometryOnSupport()

Inactivates GeometryOnSupport of circle.

Note: The circle becomes euclidean.

Note

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

o Property Element1() As Reference

Returns or sets the circle first passing point.

Sub-element(s) supported (see Boundary object): Vertex.

Example:

This example retrieves the first passing point of the HybShpCircle3Pt

hybrid shape circle in HybShpCircle3PtFirstPassingPoint

point.

Dim HybShpCircle3PtFirstPassingPoint As Reference

Set HybShpCircle3PtFirstPassingPoint=

HybShpCircle3Pt.Element1

Note

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

o Property Element2() As Reference

Returns or sets the circle second passing point.

Sub-element(s) supported (see Boundary object): Vertex.

Example:

This example sets the second passing point of the HybShpCircle3Pt

hybrid shape circle as the Point2 point.

HybShpCircle3Pt.Element2 Point2

Note

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

o Property Element3() As Reference

Returns or sets the circle third passing point.

Sub-element(s) supported (see Boundary object): Vertex.

Example:

This example retrieves the third passing point of the HybShpCircle3Pt

hybrid shape circle in HybShpCircle3PtThirdPassingPoint

point.

Dim HybShpCircle3PtThirdPassingPoint As Reference

Set HybShpCircle3PtThirdPassingPoint=

HybShpCircle3Pt.Element3

Note

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

o Sub RemoveSupport()

Removes the support surface.

Note

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

o Property Support() As Reference

Returns or sets the circle support surface.

Sub-element(s) supported (see Boundary object): Face.

Example:

This example retrieves in HybShpCircleSupportSurf the support surface

of the HybShpCircle hybrid shape circle.

Dim HybShpCircleSupportSurf As Reference

HybShpCircleSupportSurf = HybShpCircle.Support

Note

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

o Property BeginOfCircle() As long

Return or Set the number of the beginning curve of the circle. This

parameter is used to stabilize the resulting circle

Example:

This example set the beginning wire index of

the hybShpcircle hybrid shape circle

hybShpcircle.BeginOfCircle = 1

Note

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

o Property Curve1() As Reference

Returns or sets the first curve to which the circle is or will be

tangent.

Sub-element(s) supported (see Boundary object): TriDimFeatEdge or

BiDimFeatEdge.

Example:

This example retrieves in HybShpCircleFirstCurve the first curve to

which the HybShpCircle hybrid shape circle is tangent.

Dim HybShpCircleFirstCurve As Reference

HybShpCircleFirstCurve = HybShpCircle.Curve1

Note

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

o Property Curve2() As Reference

Returns or sets the second curve to which the circle is or will be

tangent.

Sub-element(s) supported (see Boundary object): TriDimFeatEdge or

BiDimFeatEdge.

Example:

This example sets the second curve to which the HybShpCircle hybrid

shape circle will be tangent to Crv5.

HybShpCircle.Curve2 Crv5

Note

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

o Property DiscriminationIndex() As long

Return or set the discrimination index of the current circle. Several

resulting solutions produced by the operator can be same oriented regarding to

the input wire bodies. In such a case, they are sorted in order to distinguish

them. The Sequence FirstOrientation - SecondOrientation - DiscriminationIndex

allows you to identify a unique one-domain solution.

Example:

This example set the discrimination index of

the hybShpcircle hybrid shape circle

hybShpcircle.DiscriminationIndex = 2

Note

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

o Property Orientation1() As long

Returns or sets the orientation of the first curve to which the circle is

tangent.

Role: The orientation of the first curve determines the side of this curve

taken into account to find the point where the circle is tangent to the curve.

This side is determined by the cross product of the normal to the support and a

tangent to the curve oriented using the curve orientation.

Legal values: 1 to state that the side of the curve to be taken into

account is the side shown by the vector resulting from this cross product, and

-1 otherwise.

Example:

This example sets the orientation of the first curve to which the

HybShpCircle hybrid shape circle is tangent to

reverse.

HybShpCircle.Orientation1 -1

Note

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

o Property Orientation2() As long

Returns or sets the orientation of the second curve to which the circle is

tangent.

Role: The orientation of the second curve determines the side of this curve

taken into account to find the point where the circle is tangent to the curve.

This side is determined by the cross product of the normal to the support and a

tangent to the curve oriented using the curve orientation.

Legal values: 1 to state that the side of the curve to be taken into

account is the side shown by the vector resulting from this cross product, and

-1 otherwise.

Example:

This example retrieves in HybShpCircleOrientation the orientation of

the second curve to which the HybShpCircle hybrid shape circle is

tangent.

HybShpCircleOrientation = HybShpCircle.Orientation2

Note

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

o Property Pt() As Reference

Returns or sets the circle passing point. This point must lie on second

curve.

Sub-element(s) supported (see Boundary object): Vertex.

Example:

This example retrieves the passing point of the HybShpCircle hybrid

shape circle in HybShpCirclePassingPoint point.

Dim HybShpCirclePassingPoint As Reference

Set HybShpCirclePassingPoint = HybShpCircle.Pt

Note

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

o Property Support() As Reference

Returns or sets the circle support surface.

Sub-element(s) supported (see Boundary object): Face.

Example:

This example retrieves in HybShpCircleSupportSurf the support surface

of the HybShpCircle hybrid shape circle.

Dim HybShpCircleSupportSurf As Reference

HybShpCircleSupportSurf = HybShpCircle.Support

Note

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

o Property TangentOrientation1() As long

Returns or sets the tangent orientation of the circle first reference

element. compared to the circle itself

Example:

This example retrieves the tangent orientation of first reference

element of

the hybShpcircle hybrid shape circle in firstOrient.

Dim firstOrient As long

firstOrient = hybShpcircle.FirstTangentOrientation

Note

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

o Property TangentOrientation2() As long

Returns or sets the tangent orientation of the circle second reference

element. compared to the corner itself

Example:

This example retrieves the tangent orientation of second reference

element of

the hybShpcircle hybrid shape circle in secondOrient.

Dim secondOrient As long

secondOrient = hybShpcircle.SecondTangentOrientation

Note

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

o Property TrimMode() As long

Returns or sets whether the circle reference curves are or should be

trimmed.

Legal values: 0 if the circle reference curves are not or should not be

trimmed, 1 if the circle reference curves are or should be trimmed, 2 if only

the first circle reference curve is or should be trimmed, 3 if only the second

circle reference curve is or should be trimmed,

Example:

This example sets that the reference curves of

the hybShpCircle hybrid shape circle should be

trimmed.

hybShpCircle.TrimMode = 1

Note

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

o Property BeginOfCircle() As long

Return or Set the number of the beginning curve of the circle. This

parameter is used to stabilize the resulting circle

Example:

This example set the beginning wire index of

the hybShpcircle hybrid shape circle

hybShpcircle.BeginOfCircle = 1

Note

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

o Property Curve1() As Reference

Returns or sets the first curve to which the circle is or will be

tangent.

Sub-element(s) supported (see Boundary object): TriDimFeatEdge or

BiDimFeatEdge.

Example:

This example retrieves in HybShpCircleFirstCurve the first curve to

which the HybShpCircle hybrid shape circle is tangent.

Dim HybShpCircleFirstCurve As Reference

HybShpCircleFirstCurve = HybShpCircle.Curve1

Note

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

o Property Curve2() As Reference

Returns or sets the second curve to which the circle is or will be

tangent.

Sub-element(s) supported (see Boundary object): TriDimFeatEdge or

BiDimFeatEdge.

Example:

This example sets the second curve to which the HybShpCircle hybrid

shape circle will be tangent to Crv5.

HybShpCircle.Curve2 Crv5

Note

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

o Property Diameter() As Length (Read Only)

Returns the circle diameter. It is expressed as a Length literal. Succeeds

only if DiameterMode is set to True.

Example:

This example retrieves in HybShpCircleDiameter the diameter of the

HybShpCircle hybrid shape circle feature

Dim HybShpCircleDiameter As Length

HybShpCircleDiameter = HybShpCircle.Diameter

Note

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

o Property DiameterMode() As boolean

Returns or sets the DiameterMode.

Legal values: True implies diameter False implies radius (default). When

DiameterMode is changed, Radius/Diameter value, which is stored will not be

modified.

Example:

This example sets that the DiameterMode of

the HybShpCircle hybrid shape circle feature

HybShpCircle.DiameterMode = True

Note

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

o Property DiscriminationIndex() As long

Return or set the discrimination index of the current circle. Several

resulting solutions produced by the operator can be same oriented regarding to

the input wire bodies. In such a case, they are sorted in order to distinguish

them. The Sequence FirstOrientation - SecondOrientation - DiscriminationIndex

allows you to identify a unique one-domain solution.

Example:

This example set the discrimination index of

the hybShpcircle hybrid shape circle

hybShpcircle.DiscriminationIndex = 2

Note

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

o Property Orientation1() As long

Returns or sets the orientation of the first curve to which the circle is

tangent.

Role: The orientation of the first curve determines the side of this curve

taken into account to find the point where the circle is tangent to the

curve.

Legal values: To be provided by Claire (1/-1??)

Example:

This example sets the orientation of the first curve to which the

HybShpCircle hybrid shape circle is tangent to

reverse.

HybShpCircle.Orientation1 -1

Note

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

o Property Orientation2() As long

Returns or sets the orientation of the second curve to which the circle is

tangent.

Role: The orientation of the second curve determines the side of this curve

taken into account to find the point where the circle is tangent to the

curve.

Legal values: To be provided by Claire (1/-1??)

Example:

This example retrieves in HybShpCircleOrientation the orientation of

the second curve to which the HybShpCircle hybrid shape circle is

tangent.

HybShpCircleOrientation = HybShpCircle.Orientation2

Note

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

o Property Radius() As Length (Read Only)

Returns the circle radius. It is expressed as a Length literal. Succeeds

only if DiameterMode is set to False.

Example:

This example retrieves in HybShpCircleRadius the radius of the HybShpCircle

hybrid shape circle.

Dim HybShpCircleRadius As Length

HybShpCircleRadius = HybShpCircle.Radius

Note

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

o Property Support() As Reference

Returns or sets the circle support surface.

Sub-element(s) supported (see Boundary object): Face.

Example:

This example retrieves in HybShpCircleSupportSurf the support surface

of the HybShpCircle hybrid shape circle.

Dim HybShpCircleSupportSurf As Reference

HybShpCircleSupportSurf = HybShpCircle.Support

Note

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

o Property TangentOrientation1() As long

Returns or sets the tangent orientation of the circle first reference

element. compared to the circle itself

Example:

This example retrieves the tangent orientation of first reference

element of

the hybShpcircle hybrid shape circle in firstOrient.

Dim firstOrient As long

firstOrient = hybShpcircle.FirstTangentOrientation

Note

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

o Property TangentOrientation2() As long

Returns or sets the tangent orientation of the circle second reference

element. compared to the corner itself

Example:

This example retrieves the tangent orientation of second reference

element of

the hybShpcircle hybrid shape circle in secondOrient.

Dim secondOrient As long

secondOrient = hybShpcircle.SecondTangentOrientation

Note

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

o Property TrimMode() As long

Returns or sets whether the circle reference curves are or should be

trimmed.

Legal values: 0 if the circle reference curves are not or should not be

trimmed, 1 if the circle reference curves are or should be trimmed, 2 if only

the first circle reference curve is or should be trimmed, 3 if only the second

circle reference curve is or should be trimmed,

Example:

This example sets that the corner reference curves

of

the hybShpCircle hybrid shape circle should be

trimmed.

hybShpCircle.TrimMode = 1

Note

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

o Property Axis() As Reference

Returns or sets the Axis of the circle.

Example:

This example retrieves in CircleAxis the Axis of plane in which circle

is lying from HybShpCircle hybrid shape circle center axis

feature

Dim CircleAxis As Reference

Set CircleAxis = HybShpCircle.Axis

Note

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

o Property Diameter() As Length (Read Only)

Returns the circle diameter. It is expressed as a Length literal. Succeeds

only if DiameterMode is set to True.

Example:

This example retrieves in HybShpCircleDiameter the diameter of the

HybShpCircle hybrid shape circle center axis feature

Dim HybShpCircleDiameter As Length

HybShpCircleDiameter = HybShpCircle.Diameter

Note

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

o Property DiameterMode() As boolean

Returns or sets the DiameterMode.

Legal values: True implies diameter False implies radius (default). When

DiameterMode is changed, Radius/Diameter value, which is stored will not be

modified.

Example:

This example sets that the DiameterMode of

the HybShpCircle hybrid shape circle center axis

feature

HybShpCircle.DiameterMode = True

Note

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

o Property Point() As Reference

Returns or sets the Point of the circle.

Example:

This example retrieves in CirclePoint the point used for center

computation from HybShpCircle hybrid shape circle center axis

feature

Dim CirclePoint As Reference

Set CirclePoint = HybShpCircle.Point

Note

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

o Property ProjectionMode() As boolean

Returns or sets the ProjectionMode.

Legal values: True (default) implies point will be projected on to

axis/line False implies that point will be center of the

circle.

Example:

This example sets that the ProjectionMode of

the HybShpCircle hybrid shape circle center axis

feature

HybShpCircle.ProjectionMode = True

Note

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

o Property Radius() As Length (Read Only)

Returns the circle radius. It is expressed as a Length literal. Succeeds

only if DiameterMode is set to False.

Example:

This example retrieves in HybShpCircleRadius the radius of the HybShpCircle

hybrid shape circle center axis feature

Dim HybShpCircleRadius As Length

HybShpCircleRadius = HybShpCircle.Radius

Copyright © 1999-2011, Dassault Systèmes. All rights

reserved.

Note

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

o Property BeginOfCircle() As long

Return or Set the number of the beginning curve of the circle. This

parameter is used to stabilize the resulting circle

Example:

This example set the beginning wire index of

the hybShpcircle hybrid shape circle

hybShpcircle.BeginOfCircle = 1

Note

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

o Property CenterElem() As Reference

Returns or sets the Center Element of the circle.

Example:

This example retrieves in HybShpCircleCenterCurve the first curve to

which the HybShpCircle hybrid shape circle is Center

curve.

Dim HybShpCircleFirstCurve As Reference

HybShpCircleFirstCurve = HybShpCircle.CenterElem

Note

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

o Property Diameter() As Length (Read Only)

Returns the circle diameter. It is expressed as a Length literal. Succeeds

only if DiameterMode is set to True.

Example:

This example retrieves in HybShpCircleDiameter the diameter of the

HybShpCircle hybrid shape circle feature

Dim HybShpCircleDiameter As Length

HybShpCircleDiameter = HybShpCircle.Diameter

Note

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

o Property DiameterMode() As boolean

Returns or sets the DiameterMode.

Legal values: True implies diameter False implies radius (default). When

DiameterMode is changed, Radius/Diameter value, which is stored will not be

modified.

Example:

This example sets that the DiameterMode of

the HybShpCircle hybrid shape circle feature

HybShpCircle.DiameterMode = True

Note

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

o Property DiscriminationIndex() As long

Return or set the discrimination index of the current circle. Several

resulting solutions produced by the operator can be same oriented regarding to

the input wire bodies. In such a case, they are sorted in order to distinguish

them. The Sequence FirstOrientation - SecondOrientation - DiscriminationIndex

allows you to identify a unique one-domain solution.

Example:

This example set the discrimination index of

the hybShpcircle hybrid shape circle

hybShpcircle.DiscriminationIndex = 2

Note

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

o Property Orientation1() As long

Returns or sets the orientation of the first curve to which the circle is

tangent.

Role: The orientation of the first curve determines the side of this curve

taken into account to find the point where the circle is tangent to the

curve.

Legal values: To be provided by Claire (1/-1??)

Example:

This example sets the orientation of the first curve to which the

HybShpCircle hybrid shape circle is tangent to

reverse.

Set HybShpCircle.Orientation1 -1

Note

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

o Property Orientation2() As long

Returns or sets the orientation of the second curve to which the circle is

tangent.

Role: The orientation of the second curve determines the side of this curve

taken into account to find the point where the circle is tangent to the

curve.

Legal values: To be provided by Claire (1/-1??)

Example:

This example retrieves in HybShpCircleOrientation the orientation of

the second curve to which the HybShpCircle hybrid shape circle is

tangent.

HybShpCircleOrientation = HybShpCircle.Orientation2

Note

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

o Property Radius() As Length (Read Only)

Returns the circle radius. It is expressed as a Length literal. Succeeds

only if DiameterMode is set to False.

Example:

This example retrieves in HybShpCircleRadius the radius of the HybShpCircle

hybrid shape circle.

Dim HybShpCircleRadius As Length

HybShpCircleRadius = HybShpCircle.Radius

Note

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

o Property Support() As Reference

Returns or sets the circle support surface.

Sub-element(s) supported (see Boundary object): Face.

Example:

This example retrieves in HybShpCircleSupportSurf the support surface

of the HybShpCircle hybrid shape circle.

Dim HybShpCircleSupportSurf As Reference

Set HybShpCircleSupportSurf = HybShpCircle.Support

Note

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

o Property TangentCurve() As Reference

Returns or sets the tangent curve to which the circle will be

tangent.

Example:

This example sets the tangent curve to which the HybShpCircle hybrid

shape circle will be tangent to TgtCrv.

Set HybShpCircle.Tangent Curve TgtCrv

Note

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

o Property TangentOrientation1() As long

Returns or sets the tangent orientation of the circle first reference

element. compared to the circle itself

Example:

This example retrieves the tangent orientation of first reference

element of

the hybShpcircle hybrid shape circle in firstOrient.

Dim firstOrient As long

firstOrient = hybShpcircle.FirstTangentOrientation

Note

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

o Property TangentOrientation2() As long

Returns or sets the tangent orientation of the circle second reference

element. compared to the corner itself

Example:

This example retrieves the tangent orientation of second reference

element of

the hybShpcircle hybrid shape circle in secondOrient.

Dim secondOrient As long

secondOrient = hybShpcircle.SecondTangentOrientation

Note

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

o Property Center() As Reference

Returns or sets the circle center.

Sub-element(s) supported (see Boundary object): Vertex.

Example:

This example retrieves in HybShpCircleCenter the center of the

HybShpCircle hybrid shape circle.

Dim HybShpCircleCenter As Reference

HybShpCircleCenter = HybShpCircle.Center