HybridShapeCircle2PointsRad (Object)

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

This data includes:

Use the CATIAHybridShapeFactory to create a HybridShapeCircle2PointsRad object.

See also:

Properties


Property Diameter() As (Read Only)
Returns the circle diameter. It is expressed as a 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
Property DiameterMode() As
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
Property Orientation() As
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
Property Pt1() As
Returns or sets the circle first passing point.
Sub-element(s) supported (see object): .
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
Property Pt2() As
Returns or sets the circle second passing point.
Sub-element(s) supported (see object): .
Example:
This example sets the second passing point of the HybShpCircle hybrid shape circle as the Point12 point. 
 HybShpCircle.Pt2 Point12
Property Radius() As (Read Only)
Returns the circle radius.
Parameters:
Radius
The circle radius, expressed as a 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
Property Support() As
Returns or sets the circle support surface.
Sub-element(s) supported (see object): .
Example:
This example retrieves in HybShpCircleSupportSurf the support surface of the HybShpCircle hybrid shape circle. 
 Dim HybShpCircleSupportSurf As Reference 
 HybShpCircleSupportSurf = HybShpCircle.Support

Methods


Func IsGeodesic() As
Queries whether the circle is geodesic or not.
Parameters:
oGeod
geodesic type : when TRUE, the circle is geodesic.
Sub SetGeometryOnSupport()
Sets GeometryOnSupport of circle.
It puts the circle on the surface. S_OK if OK, E_FAIL if fail
Sub UnsetGeometryOnSupport()
Inactivates GeometryOnSupport of circle.
Note: The circle becomes euclidean.