pycatia.hybrid_shape_interfaces.hybrid_shape_law_dist_proj

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_law_dist_proj.HybridShapeLawDistProj(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

HybridShapeLawDistProj

Interface to law feature.

Role: Allows you to access data of a law feature created by using a reference

line and a definition curve.

See also:

HybridShapeFactory

property applied_unit_symbol: str

Note

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

o Property AppliedUnitSymbol(CATBSTR iSymbol) (Write Only)

Returns or sets the applied unit symbol for heterogeneous law.

Return type:

str

property definition: Reference

Note

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

o Property Definition() As Reference

Returns or sets the definition curve of the law.

Sub-element(s) supported (see Boundary object): see TriDimFeatEdge or

BiDimFeatEdge.

Return type:

Reference

get_applied_unit_symbol(o_symbol: str) → None

Note

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

o Sub GetAppliedUnitSymbol(CATBSTR oSymbol)

Returns the applied unit symbol.

Parameters:

oSymbol

The symbol of applied unit

Example:

This example retrieves in oSymbol the applied unit symbol of the

hybridShapeLawDist hybrid shape law feature.

Dim oSymbol

hybridShapeLawDist.GetAppliedUnitSymboloSymbol

Parameters:

o_symbol (str) –

Return type:

None

get_measure_unit_symbol(o_symbol: str) → None

Note

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

o Sub GetMeasureUnitSymbol(CATBSTR oSymbol)

Returns the measure unit symbol.

Parameters:

oSymbol

The symbol of measure unit

Example:

This example retrieves in oSymbol the measure unit symbol of the

hybridShapeLawDist hybrid shape law feature.

Dim oSymbol

hybridShapeLawDist.GetMeasureUnitSymboloSymbol

Parameters:

o_symbol (str) –

Return type:

None

get_plane_normal(o_normal: tuple) → None

Note

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

o Sub GetPlaneNormal(CATSafeArrayVariant oNormal)

Retrieves the support plane normal.

Parameters:

oNormal

The support plane normal

Parameters:

o_normal (tuple) –

Return type:

None

is_heterogeneous_law() → bool

Note

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

o Func IsHeterogeneousLaw() As boolean

Queries whether Heterogeneous Law mode is active or not.

Parameters:

oHeterogeneousLaw

heterogeneous law mode = TRUE : Heterogeneous Law mode is active. =

FALSE : Heterogeneous Law mode is inactive.

Return type:

bool

property measure_unit_symbol: str

Note

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

o Property MeasureUnitSymbol(CATBSTR iSymbol) (Write Only)

Returns or sets the measure unit symbol for heterogeneous law.

Return type:

str

property parameter_on_definition: bool

Note

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

o Property ParameterOnDefinition() As boolean

Queries whether evolution parameter is on reference curve (default) or on definition curve,or

sets evolution parameter on reference curve or on definition curve.

Possible values of ParameterOnDefinition = TRUE : Parameter on definition curve. =

FALSE : Parameter on reference curve.

Example:

This example retrieves in ParOnDef the ParameterOnDefinition status of the

hybridShapeLawDist hybrid shape law feature.

Dim ParOnDef As boolean

ParOnDef = hybridShapeLawDist.ParameterOnDefinition

Return type:

bool

property positive_direction_orientation: int

Note

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

o Property PositiveDirectionOrientation() As long

Returns or sets the positive value direction.

Return type:

int

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 support plane normal.

Parameters:

iNormal

The support plane normal

Parameters:

i_normal (tuple) –

Return type:

None

property reference: Reference

Note

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

o Property Reference() As Reference

Returns or sets the reference line of the law.

Sub-element(s) supported (see Boundary object): see

RectilinearTriDimFeatEdge or RectilinearBiDimFeatEdge.

Return type:

Reference

property scaling: float

Note

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

o Property Scaling() As double

Returns or sets the scaling ratio of the law.

Return type:

float