pycatia.hybrid_shape_interfaces.hybrid_shape_curve_par

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.hybrid_shape_interfaces.hybrid_shape_curve_par.HybridShapeCurvePar(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

MecModInterfaces.HybridShape

HybridShapeCurvePar

Represents the hybrid shape curve parameter object.

Role: To access the data of the hybrid shape curve parameter object. This data

includes:

The face to process

The offset parameter.

Use the HybridShapeFactory to create a HybridShapeCurvePar

object.

property curve_offseted: Reference

Note

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 type:

Reference

property curve_par_law: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property CurveParLaw() As Reference

Returns or sets the offset law.

Example:

This example retrieves in oLaw the offset law for the hybShpCurvePar

hybrid shape feature.

Dim oLaw As Reference

Set oLaw = hybShpCurvePar.CurveParLaw

Return type:

Reference

property curve_par_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property CurveParType() As long

Returns or sets the corner type.

Legal values:

0

CATGSMCurvePar_Sharp. corner with angle.

1

CATGSMCurvePar_Round. round corner.

Example:

This example retrieves in oCurveParType the curve par type for the

hybShpCurvePar hybrid shape feature.

oCurveParType = hybShpCurvePar.CurveParType

Return type:

int

property geodesic: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Geodesic() As boolean

Returns or sets Geodesic mode.

Legal values: True Geodesic mode and False Euclidian mode

.

Example:

This example sets that the geodesic mode of

the hybShpCurvePar hybrid shape curve par feature to

True.

hybShpCurvePar.Geodesic = True

Return type:

bool

get_plane_normal() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetPlaneNormal(CATSafeArrayVariant oNormal)

Returns the Normal of the plane created when the Support of the curve is

not specified.

Parameters:

oNormal

Plane normal. It is returned as an array of three coordinates in

SafeArrayVariant

Example:

This example retrieves in oNormal the normal of the hybShpCurvePar

plane created.

Dim oNormal(2)

hybShpCurvePar.GetPlaneNormal(oNormal)

You can access each normal coordinate as follows:

x is in oNormal(0)

y is in oNormal(1)

z is in oNormal(2)

Return type:

tuple

property invert_direction: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property InvertDirection() As boolean

Returns or sets the orientation.

Legal values: True True to invert this orientation and False False means

that there is no invertion of the curve orientation (orientation is the vector

product of the tangent of the curve by the normal on the

support).

Example:

This example sets that the orientation of

the hybShpCurvePar hybrid shape curve par feature to

True.

hybShpCurvePar.InvertDirection = True

Return type:

bool

property invert_mapping_law: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property InvertMappingLaw() As boolean

Returns or sets the mapping orientation of the law (if offset is specified

by a law).

Legal values: True Law is applied from the end to the beginning of the

curve (mapping is inverted). False Law is applied from the beginning to the end

of the curve (mapping is not inverted).

Example:

This example sets that the mapping orientation of

the hybShpCurvePar hybrid shape curve par feature to

True.

hybShpCurvePar.InvertMappingLaw = True

Return type:

bool

property keep_both_sides: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property KeepBothSides() As boolean

Returns or sets the both sides mode of the curve parameter

object.

Example:

This example retrieves the both sides mode of

the hybShpCurvePar

Dim bothSides As Boolean

bothSides = hybShpCurvePar.KeepBothSides

Return type:

bool

property law_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property LawType() As long

Returns or sets the law type.

Legal values:

0

CATGSMBasicLawType_None. Undefined law type.

1

CATGSMBasicLawType_Constant. Constant law type.

2

CATGSMBasicLawType_Linear. Linear law type.

3

CATGSMBasicLawType_SType. S law type.

4

CATGSMBasicLawType_Advanced. Law specified by a GSD law

feature.

Example:

This example retrieves in oLawType the law type for the hybShpCurvePar

hybrid shape feature.

oLawType = hybShpCurvePar.LawType

Return type:

int

property maximum_deviation_value: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property MaximumDeviationValue() As double

Sets or Gets the maximum deviation allowed for smoothing

operation.

Sets in distance unit, it corresponds to the radius of a pipe around the

input curve in which the result is allowed to be. This value must be set in SI

unit (m).

Example: This example retrieves in DeviationValue the maximum deviation

value for the CurvePar hybrid shape feature.

Dim DeviationValue As CATIALength

Set DeviationValue = CurvePar.MaximumDeviationValue

Return type:

float

property offset: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Offset() As Length (Read Only)

Returns the offset parameter of the curve parameter

object.

Example:

This example retrieves the offset parameter of

the hybShpCurvePar in offsetParm.

Dim offsetParm As CATIALength

offsetParm = hybShpCurvePar.Offset

Return type:

Length

property offset2: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Offset2() As Length (Read Only)

Returns the second offset parameter of the curve parameter

object.

Example:

This example retrieves the second offset parameter

of

the hybShpCurvePar in offsetParm.

Dim offsetParm As CATIALength

offsetParm = hybShpCurvePar.Offset2

Return type:

Length

property other_side: Reference

Note

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 type:

Reference

property p_3d_smoothing: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property p3DSmoothing() As boolean

Returns or sets the ‘3D Smoothing’ option. Role: To activate or not the 3D smoothing option

Available only for tangent or curvature smoothing type TRUE : Smoothing performed without

specifying support FALSE : Smoothing performed with specific support

Example: This example retrieves in 3DSmoothingOption the support for the

Project hybrid shape feature.

Dim 3DSmoothingOption As boolean

Set 3DSmoothingOption = Project.p3DSmoothing

Return type:

bool

property passing_point: Reference

Note

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 type:

Reference

put_plane_normal(i_normal: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub PutPlaneNormal(CATSafeArrayVariant iNormal)

Sets the Normal of the plane created when the Support of the curve is not

specified.

Parameters:

iNormal

iNormal[0]

The X Coordinate of the normal vector

iNormal[1]

The Y Coordinate of the normal vector

iNormal[2]

The Z Coordinate of the normal vector

Parameters:

i_normal (tuple) –

Return type:

None

property smoothing_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SmoothingType() As long

Returns or sets the smoothing Type.

Smoothing type:

: 0 -> No Smoothing

: 2 -> G1 Smoothing : Enhance current continuity to tangent continuity

: 3 -> G2 Smoothing : Enhance current continuity to curvature continuity

Example: This example retrieves in SType the smoothing type for the

CurvePar hybrid shape feature.

Dim SType As long

Set SType = CurvePar.SmoothingType

Return type:

int

property support: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Support() As Reference

Returns or sets the support of the curve..

Example:

This example retrieves in oElem the support of the curve for the

hybShpCurvePar hybrid shape feature.

Dim oElem As Reference

Set oElem = hybShpCurvePar.Support

Return type:

Reference