pycatia.hybrid_shape_interfaces.hybrid_shape_position_transfo

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_position_transfo.HybridShapePositionTransfo(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
HybridShapePositionTransfo

Represents the hybrid shape position transformation feature
object.
Role: To access the data of the hybrid shape position transformation feature
object. This data includes:

The positioning mode
The profile to be positioned
The initila and target planes

Use the CATIAHybridShapeFactory to create a HybridShapePositionTransfo
object.

See also:
HybridShapeFactory
get_nb_pos_angle() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetNbPosAngle() As long

Gets the number of numerical positioning parameters : first axis direction angles.

Parameters:

oI
Number of parameters
Return type:

int

get_nb_pos_coord() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetNbPosCoord() As long

Gets the number of numerical positioning parameters : origin planar coordinates.

Parameters:

oI
Number of parameters
Return type:

int

get_pos_angle(i_i: int) → Angle

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPosAngle(long iI) As Angle

Returns angles of both initial and target coordinate systems from default
positions.

Parameters:

iI
The index of numerical positioning angles in initial (value 1) or
target (value 2) axis system.
oAngle
The angle value.
Parameters:

i_i (int) –

Return type:

Angle

get_pos_coord(ii: int) → Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPosCoord(long ii) As Length

Returns translation coordinates if both initial and target coordinate
systems from default positions.

Parameters:

iI
The iIndex of numerical positioning coordinates in initial (value 1
or 2) or target (value 3 or 4) coordinate system.
oCoordinate
The coordinate value
Parameters:

ii (int) –

Return type:

Length

get_pos_point(ii: int) → Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPosPoint(long ii) As Reference

Returns the points designated as the origins of the initial and target
planes.

Parameters:

iI
The plane index: 1 for initial one, 2 for target one

oElem
The origin point
Parameters:

ii (int) –

Return type:

Reference

get_pos_swap_axes(ii: int) → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPosSwapAxes(long ii) As long

Returns axis inversion from previous definitions for both initial and
target planes.

Parameters:

iI
The coordinate system index: 1 for initial one, 2 for target one

oInversion
The inversion value:

CATGSMAxisInversionMode_None
No axis inverted
CATGSMAxisInversionMode_X
Only the X axis iq inverted
CATGSMAxisInversionMode_Y
Only the Y axis is inverted
CATGSMAxisInversionMode_Both
Both axes inverted
Parameters:

ii (int) –

Return type:

int

get_position_direction(i_i: int) → HybridShapeDirection

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPositionDirection(long iI) As HybridShapeDirection

Returns the positioning directions.
The positioning direction can be initial or target plane X-axis
direction.

Parameters:

iI
The plane index: 1 for initial one, 2 for target one

oElem
The direction element
Parameters:

i_i (int) –

Return type:

HybridShapeDirection

property initial_direction_computation_mode: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property InitialDirectionComputationMode() As long

Gets or sets the computation mode of the X axis (or direction) of the
initial axis system.

Parameters:

oDirCompMode
computation mode =
0 : no X axis specified
1 : the X axis is implicitly the tangent
of the profile at the origin(the origin then HAS to be on the profile).
2 : the X axis is specified by a direction by SetPositionDirection(1,UserInputDirection).
Return type:

int

property mode: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Mode() As long

Returns or sets the positioning mode.
Legal values:

CATGSMPositionMode_NoneOrPositioned
No positioning
CATGSMPositionMode_ExplicitSweep
The explicit profile is to be moved from its initial plane to the first
sweep plane
CATGSMPositionMode_Develop
Return type:

int

property profile: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Profile() As Reference

Returns or sets the profile to be positioned.
Return type:

Reference

remove_all_pos_angle() → None

Note

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

Removes all numerical positioning parameters : first axis direction angles.
Return type:

None

remove_all_pos_coord() → None

Note

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

Removes all numerical positioning parameters : origin planar coordinates.
Return type:

None

set_pos_angle(i_i: int, i_angle: Angle) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPosAngle(long iI,
Angle iAngle)

Sets angles of both initial and target coordinate systems.

Parameters:

iI
The index of numerical positioning angles in initial (value 1) or
target (value 2) axis system.
iAngle
The angle value.
Parameters:

  • i_i (int) –

  • i_angle (Angle) –

Return type:

None

set_pos_coord(i_i: int, i_coordinate: Length) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPosCoord(long iI,
Length iCoordinate)

Sets translation coordinates of both initial and target coordinate
systems.

Parameters:

iI
The iIndex of numerical positioning coordinates in initial (value 1
or 2) or target (value 3 or 4) coordinate system.
iCoordinate
The coordinate value
Parameters:

  • i_i (int) –

  • i_coordinate (Length) –

Return type:

None

set_pos_point(i_i: int, i_elem: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPosPoint(long iI,
Reference iElem)

Sets the points designated as the origins of the initial and target
planes.

Parameters:

iI
The plane index: 1 for initial one, 2 for target one

iElem
The origin point
Parameters:
Return type:

None

set_pos_swap_axes(ii: int, i_inversion: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPosSwapAxes(long ii,
long iInversion)

Sets axis inversion from previous definitions for both initial and target
planes.

Parameters:

iI
The coordinate system index: 1 for initial one, 2 for target one

iInversion
The inversion value:

CATGSMAxisInversionMode_None
No axis inverted
CATGSMAxisInversionMode_X
Only the X axis iq inverted
CATGSMAxisInversionMode_Y
Only the Y axis is inverted
CATGSMAxisInversionMode_Both
Both axes inverted
Parameters:

  • ii (int) –

  • i_inversion (int) –

Return type:

None

set_position_direction(i_i: int, i_elem: HybridShapeDirection) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPositionDirection(long iI,
HybridShapeDirection iElem)

Sets the positioning directions.
The positioning direction can be initial or target plane X-axis
direction.

Parameters:

iI
The plane index: 1 for initial one, 2 for target one

iElem
The direction element
Parameters:
Return type:

None