def axis_plane(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property AxisPlane() As Reference
|
| Returns or sets the reference plane of the reference coordinate
| system.
| Sub-element(s) supported (see Boundary object):
| PlanarFace.
|
| Example:
| This example retrieves in RefPlane the reference plane of the reference
| coordinate system used by the Affinity hybrid shape
| feature.
|
| Dim RefPlane As Reference
| Set RefPlane = Affinity.AxisPlane
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_affinity.AxisPlane)
def item(self, i_index: cat_variant) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
| o Func Item(CATVariant iIndex) As Reference
|
| Returns a reference using its index or its name from the References
| collection.
|
| Parameters:
|
| iIndex
| The index or the name of the reference to retrieve from the
| collection of references. As a numerics, this index is the rank of the
| reference in the collection. The index of the first reference in the collection
| is 1, and the index of the last reference is Count. As a string, it is the name
| you assigned to the reference using the
|
| AnyObject.Name property.
| Returns:
| The retrieved reference
| Example:
| This example retrieves the last item in the RefList reference
| collection by means of the Count property.
|
| Dim LastRef As Reference
| Set LastRef = RefList.Item(RefList.Count)
:param cat_variant i_index:
:return: Reference
:rtype: Reference
"""
return Reference(self.references.Item(i_index))
def passing_point(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property PassingPoint() As Reference
|
| Returns or sets the passing point of the curve parameter
| object.
| Sub-element(s) supported (see Point object):
|
| Example:
|
| This example retrieves the offset curve of
| the hybShpCurvePar in offsetCrv.
|
|
| Dim PassingPoint As CATIAReference
| offsetCrv = hybShpCurvePar.PassingPoint
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_curve_par.PassingPoint)
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 reference element.This element can be a point or a
| plane.
| Sub-element(s) supported (see Boundary object): PlanarFace or
| Vertex.
|
| Example:
| This example retrieves in RefElem the reference element for the Scaling
| hybrid shape feature.
|
| Dim RefElem As Reference
| Set RefElem = Scaling.Center
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_scaling.Center)
def surface(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Surface() As Reference
|
| Role: Get the surface to which the plane is to be tangent.
|
| Parameters:
|
| oSurface
| reference surface.
|
| See also:
| Reference
| Returns:
| HRESULT S_OK if Ok E_FAIL else return error code for C++
| Implementations
| See also:
| HybridShapeFactory
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_plane_tangent.Surface)
def ref_axis_system(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property RefAxisSystem() As Reference
|
| Returns or Sets the reference Axis System for PointCoord
| feature.
| This data is not mandatory, if element is null, the absolute axis system is
| taken.
| When an element is given, X, Y and Z are considered in this Axis
| system.
| If reference point is not specified, X,Y and Z are measured from origin of
| this axis system. *
|
| Example
| :
| This example retrieves in oRefAxis the reference Axis System for
| PointCoord feature.
|
| Dim oRefAxis As CATIAReference
| Set oRefAxis = PointCoord.RefAxisSystem
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_point_coord.RefAxisSystem)
def point(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Point() As Reference
|
| Role: Get the reference point.
|
| Parameters:
|
| oPoint
| reference point.
|
| See also:
| Reference
| Returns:
| HRESULT S_OK if Ok E_FAIL else return error code for C++
| Implementations
| See also:
| HybridShapeFactory
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_plane_offset_pt.Point)
def ref_axis_system(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property RefAxisSystem() As Reference
|
| Returns or Sets the reference Axis System for Translate
| feature.
| This data is not mandatory, if element is null, the absolute axis system is
| taken.
| When an element is given, X, Y and Z are considered in this Axis system.
|
| Example
| :
| This example retrieves in oRefAxis the reference Axis System for Translate
| feature.
|
| Dim oRefAxis As CATIAReference
| Set oRefAxis = Translate.RefAxisSystem
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_translate.RefAxisSystem)
def mirroring_plane(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property MirroringPlane() As Reference
|
| Returns or sets the mirroring reference plane. It can be a plane, or a
| plane face.
| To set the property, you can use the following Boundary object:
| PlanarFace.
|
| Example:
| The following example returns in ref the mirroring reference plane of
| the mirroring firstMirroring, and then sets it to the created
| MyRef:
|
| Set ref = firstMirroring.MirroringPlane
| Set MyRef = part.CreateReferenceFromGeometry (plane)
| firstMirroring.MirroringPlane = MyRef
:return: Reference
:rtype: Reference
"""
return Reference(self.mirror.MirroringPlane)
def support(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Support() As Reference
|
| Role: To manage the support on the object.
|
| Parameters:
|
| iSupport
| return value for CATScript applications, with (IDLRETVAL) function
| type
|
| See also:
| Reference
| Returns:
| HRESULT S_OK if Ok E_FAIL else return error code for C++
| Implementations
| See also:
| HybridShapeFactory
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_rolling_offset.Support)
def get_edge_to_tear(self, i_rank: int) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func GetEdgeToTear(long iRank) As Reference
|
| Retrieves an element used by the hybrid shape unfold feature
| object.
|
| Parameters:
|
| iRank
| The rank of the element to read.
|
| Examples:
| The following example gets the oElement feature object of the
| HybridShapeUnfold object at the position iRank.
|
| Dim oElement As Reference
| Set oElement = HybridShapeUnfold.GetEdgeToTear (iRank).
:param int i_rank:
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_unfold.GetEdgeToTear(i_rank))
def get_curve(self, i_pos: int) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
| o Func getCurve(long iPos) As Reference
|
| Role: To get_Curve on the object.
|
| Parameters:
|
| iPos
| Position
|
| See also:
| long
| oCurve
| return value for CATScript applications, with (IDLRETVAL) function type
|
| See also:
| Reference
| Returns:
| HRESULT S_OK if Ok E_FAIL else return error code for C++
| Implementations
| See also:
| HybridShapeFactory
:param int i_pos:
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_rolling_offset.getCurve(i_pos))
def initial_element(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property InitialElement() As Reference
|
| Returns or sets the element used to initialize the boundary
| propagation.
| Sub-element(s) supported (see Boundary object):
| BiDimFeatEdge.
|
| Example:
| This example retrieves in InitElem the initial element of the
| ShpBoundary hybrid shape boundary feature.
|
| Dim InitElem As Reference
| InitElem = ShpBoundary.InitialElement
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_boundary.InitialElement)
def axis_first_direction(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property AxisFirstDirection() As Reference
|
| Returns or sets the first direction of the reference coordinate
| system.
| Sub-element(s) supported (see Boundary object): RectilinearTriDimFeatEdge,
| RectilinearBiDimFeatEdge or RectilinearMonoDimFeatEdge.
|
| Example:
| This example retrieves in FirstDir the first direction of the reference
| coordinate system used by the Affinity hybrid shape
| feature.
|
| Dim FirstDir As Reference
| Set FirstDir = Affinity.AxisFirstDirection
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_affinity.AxisFirstDirection)
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 supportElement the support
| element
| of the hybTrim hybrid shape trim object.
|
|
| Dim supportElement As Reference
| Set supportElement = hybTrim.Support
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_trim.Support)
def curve1(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Curve1() As Reference
|
| Returns or sets the first curve to which the circle is or will be
| tangent.
| Sub-element(s) supported (see Boundary object): TriDimFeatEdge or
| BiDimFeatEdge.
|
| Example:
| This example retrieves in HybShpCircleFirstCurve the first curve to
| which the HybShpCircle hybrid shape circle is tangent.
|
| Dim HybShpCircleFirstCurve As Reference
| HybShpCircleFirstCurve = HybShpCircle.Curve1
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_circle_bitangent_radius.Curve1)
def pt_ref(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property PtRef() As Reference
|
| Returns or Sets the reference point for PointCoord
| feature.
| This data is not mandatory, if element is null, the origin point is
| taken.
| When an element is given, X, Y and Z are measured starting from this
| point.
| Sub-element(s) supported (see Boundary object): Vertex.
|
| Example
| :
| This example retrieves in oPtRef the reference point for PointCoord
| feature.
|
| Dim oPtRef As CATIAReference
| Set oPtRef = PointCoord.PtRef
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_point_coord.PtRef)
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.
| Note: Support surface is not mandatory
|
| Sub-element(s) supported (see Boundary object): Face.
|
| Example:
| This example retrieves in oSurface the suupporting Surface (if exist)
| for the LineTangency hybrid shape feature.
|
| Dim oSurface As Reference
| Set oSurface = LineTangency.Surface
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_line_tangency.Support)
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 reference element.This element can be a point or a
| plane.
| To set the property, you can use one of the following Boundary objects:
| PlanarFace or Vertex.
|
| Example:
| This example retrieves in RefElem the reference element for the
| Scaling2 hybrid shape feature.
|
| Dim RefElem As Reference
| Set RefElem = Scaling2.Center
:return: Reference
:rtype: Reference
"""
return Reference(self.scaling2.Center)
def curve(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Curve() As Reference
|
| Returns or Sets the curve to which the line will be
| tangent.
| Sub-element(s) supported (see Boundary object): TriDimFeatEdge or
| BiDimFeatEdge.
|
| Example:
| This example retrieves in oCurve the reference curve for the
| LineTangency hybrid shape feature.
|
| Dim oCurve As Reference
| Set oCurve = LineTangency.Curve
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_line_tangency.Curve)
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 reference point.
| This data is not mandatory.
| If no point is given, the middle point on the surface is
| taken.
| Sub-element(s) supported (see Boundary object): Vertex.
|
| Example
| :
| This example retrieves in oPointRef the reference point for
| PointOnSurface feature.
|
| Dim oPointRef As CATIAReference
| Set oPointRef = PointOnSurface.PointRef
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_point_on_surface.Point)
def neutral_element(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property NeutralElement() As Reference
|
| Returns or sets the draft neutral element.
| To set the property, you can use the following Boundary object:
| PlanarFace.
|
| Example:
| The following example returns in neutral the neutral element of the
| draft domain firstDraftDomain, and then sets it to
| newNeutral:
|
| Set neutral = firstDraftDomain.NeutralElement
| firstDraftDomain.NeutralElement = newNeutral
:return: Reference
:rtype: Reference
"""
return Reference(self.draft_domain.NeutralElement)
def second_elem(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property SecondElem() As Reference
|
| Returns or sets the Second support surface feature.
|
| Example:
| This example retrieves in SecondElem the Second support element used by
| the HybShpFilletTriTangent hybrid shape feature.
|
| Dim SecondElem As Reference
| Set SecondElem = HybShpFilletTriTangent.SecondElem
|
|
| Parameters:
|
| oElem
| Second support surface feature.
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_fillet_tri_tangent.SecondElem)
def pulling_direction_element(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property PullingDirectionElement() As Reference
|
| Returns or sets the draft pulling direction element.
| To set the property, you can use one of the following Boundary objects:
| PlanarFace or RectilinearTriDimFeatEdge.
|
| Example:
| The following example returns in pullingdirection the pulling direction
| element of the draft domain firstDraftDomain, and then sets it to
| newPullingDirection:
|
| Set pullingdirection = firstDraftDomain.NeutralElement
| firstDraftDomain.PullingDirectionElement = newPullingDirection
:return: Reference
:rtype: Reference
"""
return Reference(self.draft_domain.PullingDirectionElement)
def section_plane(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property SectionPlane() As Reference
|
| Returns or sets the section plane..
|
| Parameters:
|
| oPlane
| The section oPlane
|
| Example:
| This example retrieves in RefPlane the plane of the
| section
|
| Dim RefPlane As Reference
| Set RefPlane = HybridShapeSection.SectionPlane
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_section.SectionPlane)
def first_elem(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property FirstElem() As Reference
|
| Deprecated:
| V5R17 CATIAHybridShapeTrim#GetElem Returns or sets the first element to
| be trimmed.
| Example:
|
| This example retrieves in Surface1 the first element to be trimmed
|
| for the hybTrim hybrid shape feature.
|
|
| Dim Surface1 As Reference
| Set Surface1 = hybTrim.FirstElem
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_trim.FirstElem)
def other_side(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property OtherSide() As Reference (Read Only)
|
| Returns the other side of parallel curve if both sides mode is
| on.
|
| Example:
|
| This example retrieves the other side of
| the hybShpCurvePar
|
|
| Dim otherSide As CATIAReference
| Set otherSide = hybShpCurvePar.OtherSide
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_curve_par.OtherSide)
def second_elem(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property SecondElem() As Reference
|
| Deprecated:
| V5R17 CATIAHybridShapeTrim#GetElem Returns or sets the second element
| to be trimmed.
| Example:
|
| This example retrieves in Surface2 the second element to be trimmed
|
| for the hybTrim hybrid shape trim object.
|
|
| Dim Surface2 As Reference
| Set Surface2 = hybTrim.SecondElem
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_trim.SecondElem)
def curve_offseted(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property CurveOffseted() As Reference
|
| Returns or sets the offset curve of the curve parameter
| object.
| Sub-element(s) supported (see Boundary object): see TriDimFeatEdge or
| BiDimFeatEdge.
|
| Example:
|
| This example retrieves the offset curve of
| the hybShpCurvePar in offsetCrv.
|
|
| Dim offsetCrv As CATIAReference
| offsetCrv = hybShpCurvePar.CurveOffseted
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_curve_par.CurveOffseted)
def element(self) -> Reference:
"""
.. note::
:class: toggle
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
| o Property Element() As Reference
|
| Role: To get the element inverted.
|
| Parameters:
|
| oElem
| Element inverted return value for CATScript applications, with
| (IDLRETVAL) function type
|
| See also:
| Reference
| Returns:
| HRESULT S_OK if Ok E_FAIL else return error code for C++
| Implementations
| See also:
| HybridShapeFactory
:return: Reference
:rtype: Reference
"""
return Reference(self.hybrid_shape_inverse.Element)
