All Frameworks  Object Hierarchy  This Framework  Indexes

HybridShapeConic (Object)

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

Use the HybridShapeFactory to create a HybridShapeConic object.

Property Index

ConicParameter
Returns or sets the conic parameter.
ConicUserTol
Gets or sets the conic User Tolerance.
EndPoint
Returns or sets the conic end point.
EndTangent
Returns or sets the tangent direction at the conic end point.
StartPoint
Returns or sets the conic start point.
StartTangent
Returns or sets the tangent direction at the conic start point.
SupportPlane
Returns or sets the conic supporting plane.
TangentIntPoint
Returns or sets the conic tangent intersection point.

Method Index

GetEndTangentDirectionFlag
Retrieves the tangent direction orientation at the conic end point.
GetIntermedTangent
Retrieves the tangent direction at one of the conic intermediate passing points.
GetIntermediatePoint
Retrieves one of the conic intermediate passing points.
GetIntermediateTangentDirectionFlag
Retrieves the tangent direction orientation of one of the conic intermediate points.
GetStartTangentDirectionFlag
Retrieves the tangent direction orientation at the conic start point.
SetEndTangentDirectionFlag
Sets the tangent direction orientation at the conic end point.
SetIntermediatePoint
Sets one of the conic intermediate passing points.
SetIntermediateTangentDirectionFlag
Sets the tangent direction orientation of one of the conic intermediate points.
SetIntermediateTangent
Sets the tangent direction at one of the conic intermediate passing points.
SetStartAndEndTangentsPlusConicParameter
Sets the tangent directions at conic start and end points, and the conic parameter.
SetStartAndEndTangentsPlusPassingPoint
Sets the tangent directions at conic start and end points, and a passing point.
SetStartTangentDirectionFlag
Sets the tangent direction orientation at the conic start point.
SetTangentIntersectPointPlusConicParm
Sets the intersection point of the conic tangents to the start and end points, and the conic parameter.
SetTangentIntersectPointPlusPassingPoint
Sets the intersection point of the conic tangents to the start and end points, and a passing point.
SetThreeIntermediatePassingPoints
Sets three conic intermediate passing points.
SetTwoIntermediatePassingPointsPlusOneTangent
Sets two conic intermediate passing points and a tangent at one of the passing points.
SwitchEndTangentDirection
Inverts the tangent direction orientation at the conic end point.
SwitchIntermediateTangentDirection
Inverts the tangent direction orientation of one of the conic intermediate points.
SwitchStartTangentDirection
Inverts the tangent direction orientation at the conic start point.

Properties


o Property ConicParameter() As
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
o Property ConicUserTol() As (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
o Property EndPoint() As
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
o Property EndTangent() As
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
o Property StartPoint() As
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
o Property StartTangent() As
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
o Property SupportPlane() As
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
o Property TangentIntPoint() As
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

Methods


o Sub GetEndTangentDirectionFlag( 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
o Func GetIntermedTangent( iIndexPoint) As
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)
o Sub GetIntermediatePoint( iIndexPoint,
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
o Sub GetIntermediateTangentDirectionFlag( iIndexPoint,
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
o Sub GetStartTangentDirectionFlag( 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
o Sub SetEndTangentDirectionFlag( 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
o Sub SetIntermediatePoint( iIndexPoint,
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
o Sub SetIntermediateTangentDirectionFlag( iIndexPoint,
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
o Sub SetIntermediateTangent( iIndexPoint,
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
o Sub SetStartAndEndTangentsPlusConicParameter( iStartTgt,
iEndTgt,
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
o Sub SetStartAndEndTangentsPlusPassingPoint( iStartTgt,
iEndTgt,
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
o Sub SetStartTangentDirectionFlag( 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
o Sub SetTangentIntersectPointPlusConicParm( iTgtInt,
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
o Sub SetTangentIntersectPointPlusPassingPoint( iTgtInt,
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
o Sub SetThreeIntermediatePassingPoints( iPassPt1,
iPassPt2,
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
o Sub SetTwoIntermediatePassingPointsPlusOneTangent( iPassPt1,
iPassPt2,
iTgtDir,
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
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
o Sub SwitchIntermediateTangentDirection( 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
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

Copyright © 2003, Dassault Systèmes. All rights reserved.