pycatia.hybrid_shape_interfaces.hybrid_shape_conic

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_conic.HybridShapeConic(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
HybridShapeConic

Represents the hybrid shape conic object.
Role: To access the data of the hybrid shape conic object. This data
includes:

The start point and its associated tangent contraint
The end point and its associated tangent contraint
The supporting plane
The tangent intersection point
The conic parameter: p = 0.5 (parabola), 0<=p<=0.5 (ellipse), 0.5<= p <=1.0 (hyperbola)

Use the HybridShapeFactory to create a HybridShapeConic
object.
property conic_parameter: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property ConicParameter() As double

Returns or sets the conic parameter.

Example:
This example retrieves in conicParm the conic parameter of the conic
hybConic.

Dim conicParm As double
Set conicParm = hybConic.ConicParameter
Return type:

float

property conic_user_tol: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property ConicUserTol() As Length (Read Only)

Gets or sets the conic User Tolerance.

Example:
This example retrieves in conicUserTol the conic user tolerance of the
conic HybridShapeConic.

Dim oConicUserTol As CATIALength
Set oConicUserTol = HybridShapeConic.conicUserTol


See also:
Length
Return type:

Length

property end_point: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property EndPoint() As Reference

Returns or sets the conic end point.
Sub-element(s) supported (see Boundary object): Vertex.

Example:
This example retrieves in endPt the end point of the conic
hybConic.

Dim endPt As Reference
Set endPt = hybConic.EndPoint
Return type:

Reference

property end_tangent: HybridShapeDirection

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property EndTangent() As HybridShapeDirection

Returns or sets the tangent direction at the conic end
point.

Example:
This example retrieves in endTgt the tangent direction associated with
the end point of the conic hybConic.

Dim endTgt As Reference
Set endTgt = hybConic.EndTangent
Return type:

HybridShapeDirection

get_end_tangent_direction_flag(o_orientation: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetEndTangentDirectionFlag(long oOrientation)

Retrieves the tangent direction orientation at the conic end
point.

Parameters:

oOrientation
The direction orientation applied to the tangent direction at the
conic end point
Legal values: 1 if the tangent direction is used as is, and -1 if
it is inverted

Example:

This example retrieves the direction orientation of the tangent at
the end point of
the conic hybConic.


Dim endPtTgtOrient As long
hybConic.GetEndTangentDirectionFlag endPtTgtOrient
Parameters:

o_orientation (int) –

Return type:

None

get_intermed_tangent(i_index_point: int) → HybridShapeDirection

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetIntermedTangent(long iIndexPoint) As
HybridShapeDirection

Retrieves the tangent direction at one of the conic intermediate passing
points.

Parameters:

iIndexPoint
An index that designates the passing point to
retrieve
Legal values: 1 for the first passing point, and 2 for the second
one
oTgtDir
The retrieved tangent direction at the given passing point


Example:

This example retrieves in tgtDir the tangent direction at point
passingPtIdx
through which the conic hybConic passes.


Dim tgtDir As Reference
passingPtIdx = 1
Set tgtDir = hybConic.GetIntermedTangent (passingPtIdx)
Parameters:

i_index_point (int) –

Return type:

HybridShapeDirection

get_intermediate_point(i_index_point: int, o_end_point: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetIntermediatePoint(long iIndexPoint,
Reference oEndPoint)

Retrieves one of the conic intermediate passing points.

Parameters:

iIndexPoint
An index that designates the passing point to
retrieve
Legal values: 1 for the first passing point, 2 for the second one,
and 3 for the third one
oEndPoint
The retrieved passing point

Example:

This example retrieves in passingPt the second point through
which
the conic hybConic passes.


Dim passingPt As Reference
passingPtIdx = 2
hybConic.GetIntermediatePoint passingPtIdx, passingPt
Parameters:

  • i_index_point (int) –

  • o_end_point (Reference) –

Return type:

None

get_intermediate_tangent_direction_flag(i_index_point: int, o_orientation: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetIntermediateTangentDirectionFlag(long iIndexPoint,
long oOrientation)

Retrieves the tangent direction orientation of one of the conic
intermediate points.

Parameters:

iIndexPoint
An index that designates the passing point to
retrieve
Legal values: 1 for the first passing point, and 2 for the second
one
oOrientation
The direction orientation applied to the tangent direction at the
intermediate passing point
Legal values: 1 if the tangent direction is used as is, and -1 if
it is inverted

Example:

This example retrieves the direction orientation of the tangent at
the first point through which
the conic hybConic passes.


passingPtIdx = 1
Dim passingPtTgtOrient As long
hybConic.GetIntermediateTangentDirectionFlag passingPtIdx,
passingPtTgtOrient
Parameters:

  • i_index_point (int) –

  • o_orientation (int) –

Return type:

None

get_start_tangent_direction_flag(o_orientation: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetStartTangentDirectionFlag(long oOrientation)

Retrieves the tangent direction orientation at the conic start
point.

Parameters:

oOrientation
The direction orientation applied to the tangent direction at the
conic start point
Legal values: 1 if the tangent direction is used as is, and -1 if
it is inverted

Example:

This example retrieves the direction orientation of the tangent at
the start point of
the conic hybConic.


Dim startPtTgtOrient As long
hybConic.GetStartTangentDirectionFlag
startPtTgtOrient
Parameters:

o_orientation (int) –

Return type:

None

set_end_tangent_direction_flag(i_orientation: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetEndTangentDirectionFlag(long iOrientation)

Sets the tangent direction orientation at the conic end
point.

Parameters:

iOrientation
The direction orientation to be applied to the tangent direction at
the conic end point
Legal values: 1 if the tangent direction is to be used as is, and
-1 if it must be inverted

Example:

This example sets the direction orientation of the tangent at the end
point of
the conic hybConic to the one of the direction used
for
the tangent.


endPtTgtOrient = 1
hybConic.SetEndTangentDirectionFlag endPtTgtOrient
Parameters:

i_orientation (int) –

Return type:

None

set_intermediate_point(i_index_point: int, i_end_point: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetIntermediatePoint(long iIndexPoint,
Reference iEndPoint)

Sets one of the conic intermediate passing points.

Parameters:

iIndexPoint
An index that designates the passing point to
retrieve
Legal values: 1 for the first passing point, 2 for the second one,
and 3 for the third one
iEndPoint
The passing point to set.
Sub-element(s) supported (see

Boundary object): Vertex.
Example:

This example sets passingPt as the first point through
which
the conic hybConic must pass.


Dim passingPt As Reference
… ‘ Value passingPt
passingPtIdx = 1
hybConic.SetIntermediatePoint passingPtIdx, passingPt
Parameters:

  • i_index_point (int) –

  • i_end_point (Reference) –

Return type:

None

set_intermediate_tangent(i_index_point: int, i_tgt_dir: HybridShapeDirection) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetIntermediateTangent(long iIndexPoint,
HybridShapeDirection iTgtDir)

Sets the tangent direction at one of the conic intermediate passing
points.

Parameters:

iIndexPoint
An index that designates the passing point where the tangent
direction is to be set
Legal values: 1 for the first passing point, and 2 for the second
one
iTgtDir
The direction to set as the tangent direction at the given passing
point

Example:

This example sets tgtDir as the tangent direction at the first point
through which
the conic hybConic passes.


Dim tgtDir As Reference
… ‘ Value tgtDir
passingPtIdx = 1
hybConic.SetIntermediateTangent passingPtIdx, tgtDir
Parameters:
Return type:

None

set_intermediate_tangent_direction_flag(i_index_point: int, i_orientation: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetIntermediateTangentDirectionFlag(long iIndexPoint,
long iOrientation)

Sets the tangent direction orientation of one of the conic intermediate
points.

Parameters:

iIndexPoint
An index that designates the passing point to
retrieve
Legal values: 1 for the first passing point, and 2 for the second
one
iOrientation
The direction orientation to be applied to the tangent direction at
the intermediate passing point
Legal values: 1 if the tangent direction is to be used as is, and
-1 if it must be inverted

Example:

This example sets the direction orientation of the tangent at the
first point through which
the conic hybConic passes to the inverse of the one of the direction
used for
the tangent.


passingPtIdx = 1
passingPtTgtOrient = -1
hybConic.SetIntermediateTangentDirectionFlag passingPtIdx,
passingPtTgtOrient
Parameters:

  • i_index_point (int) –

  • i_orientation (int) –

Return type:

None

set_start_and_end_tangents_plus_conic_parameter(i_start_tgt: HybridShapeDirection, i_end_tgt: HybridShapeDirection, i_conic_param: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetStartAndEndTangentsPlusConicParameter(HybridShapeDirection
iStartTgt,
HybridShapeDirection iEndTgt,
double iConicParam)

Sets the tangent directions at conic start and end points, and the conic
parameter.

Parameters:

iStartTgt
The tangent direction at the start point
iEndTgt
The tangent direction at the end point
iConicParam
The conic parameter
Legal values: p = 0.5 (parabola), 0<=p<=0.5 (ellipse), 0.5<= p <=1.0 (hyperbola)

Example:

This example sets firstDir and secondDir as the tangent directions at
the start
and end points of the conic hybConic, and conicParm as the conic
parameter.


hybConic.SetStartAndEndTangentsPlusConicParameter firstDir, secondDir,
conicParm
Parameters:
Return type:

None

set_start_and_end_tangents_plus_passing_point(i_start_tgt: HybridShapeDirection, i_end_tgt: HybridShapeDirection, i_passing_pt: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetStartAndEndTangentsPlusPassingPoint(HybridShapeDirection
iStartTgt,
HybridShapeDirection iEndTgt,
Reference iPassingPt)

Sets the tangent directions at conic start and end points, and a passing
point.

Parameters:

iStartTgt
The tangent direction at the start point.
Sub-element(s) supported (see

Boundary object): Vertex.
iEndTgt
The tangent direction at the end point
iPassingPt
A point through which the conic must pass.
Legal values: This point must differ from the start and end points.

Example:

This example sets firstDir and secondDir as the tangent directions at
the start
and end points of the conic hybConic, and passingPoint as a point
through
which the conic must pass.


hybConic.SetStartAndEndTangentsPlusPassingPoint firstDir, secondDir,
passingPoint
Parameters:
Return type:

None

set_start_tangent_direction_flag(i_orientation: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetStartTangentDirectionFlag(long iOrientation)

Sets the tangent direction orientation at the conic start
point.

Parameters:

iOrientation
The direction orientation to be applied to the tangent direction at
the conic start point
Legal values: 1 if the tangent direction is to be used as is, and
-1 if it must be inverted

Example:

This example sets the direction orientation of the tangent at the
start point of
the conic hybConic to the inverse of the one of the direction used
for
the tangent.


startPtTgtOrient = -1
hybConic.SetStartTangentDirectionFlag
startPtTgtOrient
Parameters:

i_orientation (int) –

Return type:

None

set_tangent_intersect_point_plus_conic_parm(i_tgt_int: Reference, i_conic_param: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetTangentIntersectPointPlusConicParm(Reference
iTgtInt,
double iConicParam)

Sets the intersection point of the conic tangents to the start and end
points, and the conic parameter.

Parameters:

iTgtInt
The point intersection of the conic tangents to the start and end
point.
Sub-element(s) supported (see

Boundary object): Vertex.
iConicParam
The conic parameter
Legal values: p = 0.5 (parabola), 0<=p<=0.5 (ellipse), 0.5<= p <=1.0 (hyperbola)
Example:

This example sets tgtIntPoint as the intersection point of the
tangents
to the start and end points of the conic hybConic, and conicParm as
the conic parameter.


hybConic.SetTangentIntersectPointPlusConicParm tgtIntPoint,
conicParm
Parameters:

  • i_tgt_int (Reference) –

  • i_conic_param (float) –

Return type:

None

set_tangent_intersect_point_plus_passing_point(i_tgt_int: Reference, i_passing_pt: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetTangentIntersectPointPlusPassingPoint(Reference
iTgtInt,
Reference iPassingPt)

Sets the intersection point of the conic tangents to the start and end
points, and a passing point.

Parameters:

iTgtInt
The point intersection of the conic tangents to the start and end
point.
Sub-element(s) supported (see

Boundary object): Vertex.
iPassingPt
A point through which the conic must pass.
Legal values: This point must differ from the start and end
points.
Sub-element(s) supported (see Boundary object):
Vertex.
Example:

This example sets tgtIntPoint as the intersection point of the
tangents
to the start and end points of the conic hybConic, and passingPoint as
a point through
which the conic must pass.


hybConic.SetTangentIntersectPointPlusPassingPoint tgtIntPoint,
passingPoint
Parameters:
Return type:

None

set_three_intermediate_passing_points(i_pass_pt1: Reference, i_pass_pt2: Reference, i_pass_pt3: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetThreeIntermediatePassingPoints(Reference iPassPt1,
Reference iPassPt2,
Reference iPassPt3)

Sets three conic intermediate passing points.

Parameters:

iPassPt1
The first intermediate passing point.
Sub-element(s) supported (see

Boundary object): Vertex.
iPassPt2
The second intermediate passing point.
Sub-element(s) supported (see Boundary object):
Vertex.
iPassPt3
The third intermediate passing point.
Sub-element(s) supported (see Boundary object):
Vertex.
Example:

This example sets passingPoint1, passingPoint2, and passingPoint3 as
the
three intermediate points through which the conic hybConic must
pass.


hybConic.SetThreeIntermediatePassingPoints passingPoint1,
passingPoint2, passingPoint3
Parameters:
Return type:

None

set_two_intermediate_passing_points_plus_one_tangent(i_pass_pt1: Reference, i_pass_pt2: Reference, i_tgt_dir: HybridShapeDirection, i_index_point: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetTwoIntermediatePassingPointsPlusOneTangent(Reference
iPassPt1,
Reference iPassPt2,
HybridShapeDirection iTgtDir,
long iIndexPoint)

Sets two conic intermediate passing points and a tangent at one of the
passing points.

Parameters:

iPassPt1
The first intermediate passing point.
Sub-element(s) supported (see

Boundary object): Vertex.
iPassPt2
The second intermediate passing point.
Sub-element(s) supported (see Boundary object):
Vertex.
iTgtDir
The tangent direction at one of the intermediate passing points

iIndexPoint
An index indicating the passing point to which the tangent direction
applies
Legal values: 1 for the first passing point, and 2 for the second one

Example:

This example sets passingPoint1 and passingPoint2 as
two
intermediate points through which the conic hybConic must
pass,
tgtDir as the tangent direction at the passing point designated by
passingPointIdx.


hybConic.SetTwoIntermediatePassingPointsPlusOneTangent passingPoint1,
passingPoint2, tgtDir, passingPointIdx
Parameters:
Return type:

None

property start_point: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property StartPoint() As Reference

Returns or sets the conic start point.
Sub-element(s) supported (see Boundary object): Vertex.

Example:
This example sets startPt as the start point of the conic
hybConic.

Dim startPt As Reference
… ‘ Value startPt
hybConic.StartPoint startPt
Return type:

Reference

property start_tangent: HybridShapeDirection

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property StartTangent() As HybridShapeDirection

Returns or sets the tangent direction at the conic start
point.

Example:
This example sets startTgt as the tangent direction at the start point
of the conic hybConic.

Dim startTgt As Reference
… ‘ Value startTangent
hybConic.StartTangent startTgt
Return type:

HybridShapeDirection

property support_plane: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property SupportPlane() As Reference

Returns or sets the conic supporting plane.
Sub-element(s) supported (see Boundary object):
PlanarFace.

Example:
This example retrieves in supportPln the supporting plane of the conic
hybConic.

Dim supportPln As Reference
Set supportPln = hybConic.SupportPlane
Return type:

Reference

switch_end_tangent_direction() → None

Note

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

Inverts the tangent direction orientation at the conic end
point.

Example:

This example inverts the direction orientation of the tangent at the
end point of
the conic hybConic.


hybConic.SwitchEndTangentDirection
Return type:

None

switch_intermediate_tangent_direction(i_index_point: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SwitchIntermediateTangentDirection(long iIndexPoint)

Inverts the tangent direction orientation of one of the conic intermediate
points.

Parameters:

iIndexPoint
An index that designates the passing point where the tangent
direction is to be inverted
Legal values: 1 for the first passing point, and 2 for the second
one

Example:

This example inverts the direction orientation of the tangent at the
first point through which
the conic hybConic passes.


passingPtIdx = 1
hybConic.SwitchIntermediateTangentDirection
passingPtIdx
Parameters:

i_index_point (int) –

Return type:

None

switch_start_tangent_direction() → None

Note

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

Inverts the tangent direction orientation at the conic start
point.

Example:

This example inverts the direction orientation of the tangent at the
start point of
the conic hybConic.


hybConic.SwitchStartTangentDirection
Return type:

None

property tangent_int_point: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property TangentIntPoint() As Reference

Returns or sets the conic tangent intersection point.
Sub-element(s) supported (see Boundary object): Vertex.

Example:
This example retrieves in tgtIntPt the tangent intersection point of
the conic hybConic.

Dim tgtIntPt As Reference
Set tgtIntPt = hybConic.TangentIntPoint
Return type:

Reference