All Frameworks  Object Hierarchy  This Framework  Indexes  Previous Next

HybridShapeCircleCtrRad (Object)

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

This data includes:

Use the CATIAHybridShapeFactory to create a HybridShapeCircleCtrRad object.

See also:
HybridShapeFactory

Property Index

Center
Returns or sets the circle center.
DiameterMode
Returns or sets the DiameterMode.
Diameter
Returns the circle diameter.
FirstDirection
Returns or sets the first direction used to set the angles reference.
Radius
Returns the circle radius.
Support
Returns or sets the circle support surface.

Method Index

GetSecondDirection
Gets the second direction on the plane to compute the point (for stability).
IsGeodesic
Queries whether the circle is geodesic or not.
SetGeometryOnSupport
Sets GeometryOnSupport of circle.
SetSecondDirection
Sets the second direction on the plane to compute the point (for stability).
UnsetGeometryOnSupport
Inactivates GeometryOnSupport of circle.

Properties


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
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
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
o Property FirstDirection() As HybridShapeDirection
Returns or sets the first direction used to set the angles reference.
Example:
This example retrieves in myHybridShapeDirection the first direction of the HybShpCircle hybrid shape circle feature 
 Dim myHybridShapeDirection As CATIAHybridShapeDirection 
 myHybridShapeDirection = HybShpCircle.FirstDirection
See also:
HybridShapeDirection
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
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

Methods


o Sub GetSecondDirection(double oDirX,
double oDirY,
double oDirZ)
Gets the second direction on the plane to compute the point (for stability).
This direction has to be kept perpendicular to the first direction
Parameters:
oDirX,
oDirY, oDirZ. second direction
See also:
HybridShapeDirection
o Func IsGeodesic() As boolean
Queries whether the circle is geodesic or not.
Parameters:
oGeod
geodesic type : when TRUE, the circle is geodesic.
o Sub SetGeometryOnSupport()
Sets GeometryOnSupport of circle.
It puts the circle on the surface.
o Sub SetSecondDirection(double iDirX,
double iDirY,
double iDirZ)
Sets the second direction on the plane to compute the point (for stability).
This direction has to be kept perpendicular to the first direction
Parameters:
iDirX,
iDirY, iDirZ. second direction
See also:
HybridShapeDirection
o Sub UnsetGeometryOnSupport()
Inactivates GeometryOnSupport of circle.
Note: The circle becomes euclidean.

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