def support(self) -> Reference: """ .. note:: :class: toggle 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: Reference :rtype: Reference """ return Reference(self.hybrid_shape_circle_bitangent_point.Support)
def point(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Point() As Reference | | Returns or Sets the starting point of the line. | Sub-element(s) supported (see Boundary object): Vertex. | | Example: | This example retrieves in oPoint the starting point for the LineNormal | hybrid shape feature. | | Dim oPoint As Reference | Set oPoint = LineNormal.Point :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_line_normal.Point)
def point(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Point() As Reference | | Returns or sets the Point of the circle. | | Example: | This example retrieves in CirclePoint the point used for center | computation from HybShpCircle hybrid shape circle center axis | feature | | Dim CirclePoint As Reference | Set CirclePoint = HybShpCircle.Point :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_circle_center_axis.Point)
def support_surface(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property SupportSurface() As Reference | | Returns or sets the support surface. | | Example: | The following example returns in SupportSurface the support surface | required for autofillet autoFillet, and then sets it to | NewSupportSurface: | | Set SupportSurface = autoFillet.SupportSurface | autofillet.SupportSurface = NewSupportSurface :return: Reference :rtype: Reference """ return Reference(self.auto_fillet.SupportSurface)
def support(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Support() As Reference | | Returns or Sets the supporting surface. | Sub-element(s) supported (see Boundary object): Face. | | Example: | This example retrieves in oSurface the surface for the LineBiTangent | hybrid shape feature. | | Dim oSurface As Reference | Set oSurface = LineBiTangent.Surface :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_line_bi_tangent.Support)
def get_cutting_elem(self, i_rank: int) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)) | o Func GetCuttingElem(long iRank) As Reference | | Gets the cutting feature at a given index (a point, a curve or a | surface). | | Parameters: | | oElem | cutting feature | iRank | Index of one of the cutting features :param int i_rank: :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_split.GetCuttingElem(i_rank))
def parting_element(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property PartingElement() As Reference | | Returns or sets the parting element. | | Example: | The following example returns in PartingElement the parting element of | the AutoDraft AutoDraft, and then sets it to | NewpartingElement: | | Set PartingElement = AutoDraft.PartingElement | AutoDraft.PartingElement = NewPartingElement :return: Reference :rtype: Reference """ return Reference(self.auto_draft.PartingElement)
def center(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Center() As Reference | | Returns or sets the sphere center. | Sub-element(s) supported (see Boundary object): Vertex. | | Example: | This example retrieves in HybShpSphereCenter the center of the | HybShpSphere hybrid shape sphere. | | Dim HybShpSphereCenter As Reference | HybShpSphereCenter = HybShpSphere.Center :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_sphere.Center)
def main_draft_angle(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property MainDraftAngle() As Reference | | Returns or sets the main draft angle. | | Example: | The following example returns in MainDraftAngle the main draft angle of | the AutoDraft AutoDraft, and then sets it to | NewMainDraftAngle.: | | Set MainDraftAngle = AutoDraft.MainDraftAngle | AutoDraft.MainDraftAngle = NewMainDraftAngle :return: Reference :rtype: Reference """ return Reference(self.auto_draft.MainDraftAngle)
def pulling_direction(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property PullingDirection() As Reference | | Returns or sets the pulling direction. | | Example: | The following example returns in PullingDirection the pulling direction | of the AutoDraft AutoDraft, and then sets it to | NewPullingDirection.: | | Set PullingDirection = AutoDraft.PullingDirection | AutoDraft.PullingDirection = NewPullingDirection :return: Reference :rtype: Reference """ return Reference(self.auto_draft.PullingDirection)
def axis_origin(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property AxisOrigin() As Reference | | Returns or sets the origin of the reference coordinate | system. | Sub-element(s) supported (see Boundary object): Vertex. | | Example: | This example retrieves in Origin the origin of the reference coordinate | system used by the Affinity hybrid shape feature. | | Dim Origin As Reference | Set Origin = Affinity.AxisOrigin :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_affinity.AxisOrigin)
def pt1(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Pt1() As Reference | | Returns or sets the circle first passing point. | Sub-element(s) supported (see Boundary object): Vertex. | | 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 :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_circle2_points_rad.Pt1)
def first_component_profile(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property FirstComponentProfile() As Reference | | Returns or sets the profile of first component of | SolidCombine. | | Example: | The following example returns in firstProfile the profile of first | component of firstSolidCombine SolidCombine feature, and then sets it to the | firstProfile2 profile element: | | Set firstProfile = firstSolidCombine.FirstComponentProfile | Set firstSolidCombine.FirstComponentProfile = firstProfile2 :return: Reference :rtype: Reference """ return Reference(self.solid_combine.FirstComponentProfile)
def first_component_direction(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property FirstComponentDirection() As Reference | | Returns or sets the direction of first component of | SolidCombine. | | Example: | The following example returns in firstDirection the direction of first | component of firstSolidCombine SolidCombine feature, and then sets it to the | firstDirection2 direction element. | | Set firstDirection = firstSolidCombine.FirstComponentDirection | Set firstSolidCombine.FirstComponentDirection = firstDirection2 :return: Reference :rtype: Reference """ return Reference(self.solid_combine.FirstComponentDirection)
def support(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Support() As Reference | | Returns or sets the support used to create the bisecting | line. | | Parameters: | | oElem | retrieve the support of the bisecting line. | Sub-element(s) supported (see | | Boundary object): see Face. :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_line_bisecting.Support)
def elem_to_project(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property ElemToProject() As Reference | | Returns or sets the element to project.This element can be a point or a | curve. | Sub-element(s) supported (see Boundary object): TriDimFeatEdge, | BiDimFeatEdge or Vertex. | | Example: This example retrieves in Elem the element to project for the | Project hybrid shape feature. | | Dim Elem As Reference | Set Elem = Project.ElemToProject :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_project.ElemToProject)
def support(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Support() As Reference | | Returns or sets the support element. | This support element may not exist. | Sub-element(s) supported (see Boundary object): Face. | | Example: | This example retrieves in Element the support element for the Split | hybrid shape feature. | | Dim Element As Reference | Set Element = Split.Support :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_split.Support)
def cutting_elem(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property CuttingElem() As Reference | | Returns or sets the cutting element. | Sub-element(s) supported (see Boundary object): Face, TriDimFeatEdge, | BiDimFeatEdge or Vertex. | | Example: | This example retrieves in CuttingElement the cutting element for the | Split hybrid shape feature. | | Dim CuttingElement As Reference | Set CuttingElement = Split.CuttingElem :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_split.CuttingElem)
def support(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Support() As Reference | | Returns or sets the support surface around which the boundary is | computed. | Sub-element(s) supported (see Boundary object): Face. | | Example: | This example retrieves in SupSurf the initial element of the | ShpBoundary hybrid shape boundary feature. | | Dim SupSurf As Reference | SupSurf = ShpBoundary.Support :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_boundary.Support)
def surface(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Surface() As Reference | | Returns or Sets the surface. | Sub-element(s) supported (see Boundary object): Face. | | Example | : | This example retrieves in oSurface the supporting surface for | PointOnSurface feature. | | Dim oSurface As CATIAReference | Set oSurface = PointOnSurface.Surface :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_point_on_surface.Surface)
def curve2(self) -> Reference: """ .. note:: :class: toggle 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: Reference :rtype: Reference """ return Reference(self.hybrid_shape_circle_bitangent_radius.Curve2)
def support(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Support() As Reference | | Returns or sets the support surface used to create the | reflectline. | Sub-element(s) supported (see Boundary object): Face. | | Example: | This example retrieves in Surface the support surface for the | RelectLine hybrid shape feature. | | Dim Surface As Reference | Set Surface = ReflectLine.Support :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_reflect_line.Support)
def support(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Support() As Reference | | Returns or sets the support element.This element can be a plane or a | surface. | Sub-element(s) supported (see Boundary object): Face, TriDimFeatEdge or | BiDimFeatEdge. | | Example: This example retrieves in SupportElem the support for the Project | hybrid shape feature. | | Dim SupportElem As Reference | Set SupportElem = Project.Support :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_project.Support)
def get_internal_edges_element(self, i_pos: int) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)) | o Func GetInternalEdgesElement(long iPos) As Reference | | Gets an element in the list of internal elements (vertex or | edges). | | Parameters: | | oInternalElement | internal element | iPos | position of internal element to be retrieved. :param int i_pos: :return: Reference :rtype: Reference """ return Reference( self.hybrid_shape_extrapol.GetInternalEdgesElement(i_pos))
def create_reference_from_name(self, i_label: str) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)) | o Func CreateReferenceFromName(CATBSTR iLabel) As Reference | | Creates a reference from a GenericNaming label. Each kind of document | provides a specific implementation. | | Parameters: | | iLabel | The GenericNaming identification for an object. | | Returns: | The reference to the object. :param str i_label: :return: Reference :rtype: Reference """ return Reference(self.document.CreateReferenceFromName(i_label))
def pt_extremity(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property PtExtremity() As Reference | | Returns or Sets the extremity point of the LinePtPt(Second | Point). | Sub-element(s) supported (see Boundary object): Vertex. | | Example: | This example retrieves in oPtExtremity the ending point for the | LinePtPt hybrid shape feature. | | Dim oPtExtremity As Reference | Set oPtExtremity = LinePtPt.PtExtremity :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_line_pt_pt.PtExtremity)
def origin(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Origin() As Reference | | Returns or sets the origin point used to create the conical | reflectline. | Sub-element(s) supported (see Boundary object): Vertex. | | Example: | This example retrieves in Point the origin point for the conical | ReflectLine hybrid shape feature. | | Dim Point As Reference | Set Point = ReflectLine.Origin :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_reflect_line.Origin)
def pt_origin(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property PtOrigine() As Reference | | Returns or Sets the origin point of the LinePtPt(First | point). | Sub-element(s) supported (see Boundary object): Vertex. | | Example: | This example retrieves in oPtOrigine the initial point for the LinePtPt | hybrid shape feature. | | Dim oPtOrigine As Reference | Set oPtOrigine = LinePtPt.PtOrigine :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_line_pt_pt.PtOrigine)
def axis(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property Axis() As Reference | | Returns or sets the rotation axis. | To set the property, you can use one of the following Boundary objects: | RectilinearTriDimFeatEdge, RectilinearBiDimFeatEdge or | RectilinearMonoDimFeatEdge. | | Example: This example retrieves in RotationAxis the rotation axis for the | Rotate hybrid shape feature. | | Dim RotationAxis As Reference | Set RotationAxis = Rotate.Axis :return: Reference :rtype: Reference """ return Reference(self.rotate.Axis)
def projection_surface(self) -> Reference: """ .. note:: :class: toggle CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384) | o Property ProjectionSurface() As Reference | | Returns or sets the projection surface to compute the | point. | | Example | : | This example retrieves in oProjSur the projection surface of the | PointOnPlane feature. | | Dim oProjSur As CATIAReference | Set oProjSur = PointOnPlane.ProjectionSurface :return: Reference :rtype: Reference """ return Reference(self.hybrid_shape_point_on_plane.ProjectionSurface)