pycatia.hybrid_shape_interfaces.hybrid_shape_circle_bitangent_radius

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.hybrid_shape_interfaces.hybrid_shape_circle_bitangent_radius.HybridShapeCircleBitangentRadius(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
MecModInterfaces.HybridShape
CATGSMIDLItf.HybridShapeCircle
HybridShapeCircleBitangentRadius

Represents the hybrid shape circle object defined using a radius and tangent to
two curves.
Role: To access the data of the hybrid shape circle object.

This data includes:

The circle radius
The two curves to which the circle is tangent
The surface that supports the circle
The orientation of each curve

Use the CATIAHybridShapeFactory to create a HybridShapeCircleBitangentRadius
object.

See also:
HybridShapeFactory
property begin_of_circle: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

int

property curve1: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

Reference

property curve2: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

Reference

property diameter: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

Length

property diameter_mode: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

bool

property discrimination_index: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

int

property orientation1: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

int

property orientation2: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

int

property radius: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

Length

property support: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

Reference

property tangent_orientation1: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

int

property tangent_orientation2: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

int

property trim_mode: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

int