pycatia.mec_mod_interfaces.axis_system

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.mec_mod_interfaces.axis_system.AxisSystem(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
AxisSystem

The object Axis System A axis system has got one origin point and three
orthogonal axes, crossing at the origin point.
property axis_rotation_angle: Angle

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property AxisRotationAngle() As Angle (Read Only)

Returns the rotation angle of an axis system. Succeeds only if the axis
system is defined by a rotation around an axis, wich means that its type is
catAxisSystemAxisRotation.
Return type:

Angle

property axis_rotation_reference: Reference

Note

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

Returns the reference for the axis rotation. Succeeds only if the axis
system is defined by a rotation around an axis, wich means that its type is
catAxisSystemAxisRotation.
Return type:

Reference

get_euler_angles() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetEulerAngles(Angle oFirstAngle,
Angle oSecondAngle,
Angle ThirdAngle)

Returns the Euler Angles of an axis system. Succeeds only if the axis
system is defined by Euler angles, wich means its type is
catAxisSystemEulerAngles.
Parameters:

  • o_first_angle (Angle) –

  • o_second_angle (Angle) –

  • third_angle (Angle) –

Return type:

None

get_origin() → tuple

Note

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

Returns the coordinates X,Y,Z of the origin point of the axis
system.

Parameters:

oOrigin
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the origin point of the axis system.


Example:
The following example retrieves in originCoord the coordinates of the
origin point of the axisSystem axis system:

Dim originCoord(2)
axisSystem.GetOrigin originCoord
Parameters:

o_origin (tuple) –

Return type:

None

get_vectors() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetVectors(CATSafeArrayVariant oVectorX,
CATSafeArrayVariant oVectorY)

Returns the coordinates X,Y,Z of the axes X and Y of the axis
system.

Parameters:

oVectorX
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the X axis vector of the axis system.

oVectorY
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the Y axis vector of the axis system.


Example:
The following example retrieves in vectorXCoord and vectorYCoord the
coordinates of the vectors of the axisSystem axis
system:

Dim vectorXCoord(2)
Dim vectorYCoord(2)
axisSystem.GetVectors vectorXCoord, vectorYCoord
Return type:

None

get_x_axis() → tuple

Note

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

Returns the coordinates X,Y,Z of the X axis of the axis
system.

Parameters:

oXAxis
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the X axis of the axis system.


Example:
The following example retrieves in XAxisCoord the coordinates of the X
axis of the axisSystem axis system:

Dim XAxisCoord(2)
axisSystem.GetXAxis XAxisCoord
Parameters:

o_x_axis (tuple) –

Return type:

None

get_y_axis() → tuple

Note

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

Returns the coordinates X,Y,Z of the Y axis of the axis
system.

Parameters:

oYAxis
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the Y axis of the axis system.


Example:
The following example retrieves in YAxisCoord the coordinates of the Y
axis of the axisSystem axis system:

Dim YAxisCoord(2)
axisSystem.GetYAxis XAxisCoord
Parameters:

o_y_axis (tuple) –

Return type:

None

get_z_axis() → tuple

Note

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

Returns the coordinates X,Y,Z of the Z axis of the axis
system.

Parameters:

oZAxis
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the Z axis of the axis system.


Example:
The following example retrieves in ZAxisCoord the coordinates of the Z
axis of the axisSystem axis system:

Dim ZAxisCoord(2)
axisSystem.GetZAxis ZAxisCoord
Parameters:

o_z_axis (tuple) –

Return type:

None

property is_current: bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property IsCurrent() As boolean

Returns True if the axis system is the current one, else returns False.
Sets the axis system as the current one or not.

Example:
The following example returns in isCurrent True if the axis system
axisSystem is the current one :

isCurrent = axisSystem.IsCurrent

The following example sets the axis system axisSystem as the current
one :

axisSystem.IsCurrent = 1

The following example sets the axis system axisSystem as not the
current one :

axisSystem.IsCurrent = 0
Return type:

bool

property origin_point: Reference

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property OriginPoint() As Reference

Returns or sets the geometric point which defines the origin of the axis
system.
OriginPoint is and must be a reference on a geometric 3D
point.

Example:
The following example sets the point Point.1 of the Geometrical Set
Geometrical Set.1 as the origin point of the axis system
AxisSystem0:

Dim HybridBody4 As AnyObject
Set HybridBody4 = Body1.HybridBodies.Item ( “Geometrical Set.1” )
Dim HybridShapePointCoord5 As AnyObject
Set HybridShapePointCoord5 = HybridBody4.HybridShapes.Item ( “Point.1” )
Dim Reference6 As Reference
Set Reference6 = CATIA.ActiveDocument.Part.CreateReferenceFromGeometry(HybridShapePointCoord5)
AxisSystem0.OriginPoint = Reference6
Return type:

Reference

property origin_type: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property OriginType() As CATAxisSystemOriginType

Returns or sets the way the origin point is defined.
The origin point can be not specified, or be defined by coordinates or by a
geometric point.
CATAxisSystemOriginType is the enumeration which describes how the origin
point is defined :
If OriginType=0, the origin point is defined by a geometric point. If no
point si selected, the origin will be automatically put at the intersection of
the lines or planes defining the axes.
If OriginType=1, the origin is defined by three coordinates x,y,z. Then,
the origin will allways stays at the position defined by the
coordinates.

Example:
The following example prints the origin type :

Catia.SystemService.Print “ OriginType = “ & axisSystem.OriginType

The following example sets the origin type to 1 :

axisSystem.OriginType = 1
Returns:

enum cat_axis_system_origin_type

Return type:

int

put_origin(i_origin: tuple) → None

Note

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

Defines the coordinates X,Y,Z of the origin point of the axis
system.

Parameters:

iOrigin
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the origin point of the axis system.


Example:
The following example puts in originCoord the new coordinates of the
origin point of the axisSystem axis system:

Dim originCoord(2)
originCoord ( 0 ) = 100.000000
originCoord ( 1 ) = 200.000000
originCoord ( 2 ) = 10.000000
axisSystem.PutOrigin originCoord
Parameters:

i_origin (tuple) –

Return type:

None

put_vectors(i_vector_x: tuple, i_vector_y: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub PutVectors(CATSafeArrayVariant iVectorX,
CATSafeArrayVariant iVectorY)

Defines the coordinates X,Y,Z of the axes X and Y of the axis
system.

Parameters:

iVectorX
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the X axis vector of the axis system.

iVectorY
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the Y axis vector of the axis system.


Example:
The following example modifies in vectorXCoord and vectorYCoord the
coordinates of the vectors of the axisSystem axis
system:

Dim vectorXCoord(2)
vectorYCoord ( 0 ) = 1.000000
vectorYCoord ( 1 ) = -1.000000
vectorYCoord ( 2 ) = 0.000000
Dim vectorYCoord(2)
vectorYCoord ( 0 ) = 0.000000
vectorYCoord ( 1 ) = 0.000000
vectorYCoord ( 2 ) = 1.000000
axisSystem.PutVectors vectorXCoord, vectorYCoord
Parameters:

  • i_vector_x (tuple) –

  • i_vector_y (tuple) –

Return type:

None

put_x_axis(i_x_axis: tuple) → None

Note

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

Defines the coordinates X,Y,Z of the X axis of the axis
system.

Parameters:

iXAxis
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the X axis of the axis system.


Example:
The following example puts in XAxisCoord the new coordinates of the X
axis of the axisSystem axis system:

Dim XAxis(2)
XAxis ( 0 ) = 100.000000
XAxis ( 1 ) = 200.000000
XAxis ( 2 ) = 10.000000
axisSystem.PutXAxis XAxis
Parameters:

i_x_axis (tuple) –

Return type:

None

put_y_axis(i_y_axis: tuple) → None

Note

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

Defines the coordinates X,Y,Z of the Y axis of the axis
system.

Parameters:

iYAxis
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the Y axis of the axis system.


Example:
The following example puts in XAxisCoord the new coordinates of the Y
axis of the axisSystem axis system:

Dim YAxis(2)
YAxis ( 0 ) = 100.000000
YAxis ( 1 ) = 200.000000
YAxis ( 2 ) = 10.000000
axisSystem.PutYAxis YAxis
Parameters:

i_y_axis (tuple) –

Return type:

None

put_z_axis(i_z_axis: tuple) → None

Note

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

Defines the coordinates X,Y,Z of the Z axis of the axis
system.

Parameters:

iZAxis
A Safe Array made up of 3 doubles: X, Y, Z, representing the
coordinates in model space of the Z axis of the axis system.


Example:
The following example puts in ZAxisCoord the new coordinates of the Z
axis of the axisSystem axis system:

Dim ZAxis(2)
ZAxis ( 0 ) = 100.000000
ZAxis ( 1 ) = 200.000000
ZAxis ( 2 ) = 10.000000
axisSystem.PutZAxis ZAxis
Parameters:

i_z_axis (tuple) –

Return type:

None

property type: int

Note

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

Returns or sets the type of the axis system. Sets the axis system
type.

Example:
The following example returns in type1 the type of the axis system
axisSystem1:

type1 = axisSystem1.Type

The following example sets the type of the axis system axisSystem1 as
standard:

axisSystem1.Type = 0

The following example sets the type of the axis system axisSystem1 as
axis rotation:

axisSystem1.Type = 1

The following example sets the type of the axis system axisSystem1 as datum
(explicit):

axisSystem1.Type = 3
Returns:

enum cat_axis_system_main_type

Return type:

int

property x_axis_direction: Reference

Note

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

Reads or sets the geometric point, line or plane which defines the
direction of the X axis.
AxisDirection is and must be a reference on a 3D point or 3D line or
plane.

Example:
The following example sets the point Point.1 of the Geometrical Set
Geometrical Set.1 as the direction of the X axis of the axis system
AxisSystem0:

Dim HybridBody4 As AnyObject
Set HybridBody4 = Body1.HybridBodies.Item ( “Geometrical Set.1” )
Dim HybridShapePointCoord5 As AnyObject
Set HybridShapePointCoord5 = HybridBody4.HybridShapes.Item ( “Point.1” )
Dim Reference6 As Reference
Set Reference6 = CATIA.ActiveDocument.Part.CreateReferenceFromGeometry( HybridShapePointCoord5 )
AxisSystem0.XAxisDirection = Reference6
Return type:

Reference

property x_axis_type: int

Note

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

Reads or sets the way the X axis is specified.
An axis X,Y, or Z of the axis system can be defined by a geometric point,
line or plane, or by coordinates.
AxisType = 0 : The axis is defined by a geometric point, line or plane and with the same
direction.
AxisType = 1 : The axis direction is defined by the three coordinates x,y,z, of a vector, to
which the axis will always stay parallel.
AxisType = 2 : the axis is defined by a geometric point, line or plane and with the opposite
direction. Notice : If the X axis is neither defined by coordinates nor by a
point,line or plane, the axis will be automatically computed in order to build an
orthogonal axis system with the other specified axes.

Example:
The following example prints the X axis type :

Catia.SystemService.Print “ XAxisType = “ & axisSystem.XAxisType

The following example sets the X axis type to 1 :

axisSystem.XAxisType = 1
Returns:

enum cat_axis_system_axis_type

Return type:

int

property y_axis_direction: Reference

Note

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

Reads or sets the geometric point, line or plane which defines the
direction of the Y axis.
AxisDirection is and must be a reference on a 3D point or 3D line or
plane.

Example:
The following example sets the point Point.1 of the Geometrical Set
Geometrical Set.1 as the direction of the Y axis of the axis system
AxisSystem0:

Dim HybridBody4 As AnyObject
Set HybridBody4 = Body1.HybridBodies.Item ( “Geometrical Set.1” )
Dim HybridShapePointCoord5 As AnyObject
Set HybridShapePointCoord5 = HybridBody4.HybridShapes.Item ( “Point.1” )
Dim Reference6 As Reference
Set Reference6 = CATIA.ActiveDocument.Part.
CreateReferenceFromGeometry(HybridShapePointCoord5 )
AxisSystem0.YAxisDirection = Reference6
Return type:

Reference

property y_axis_type: int

Note

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

Reads or sets the way the Y axis is specified.
An axis X,Y, or Z of the axis system can be defined by a geometric point,
line or plane, or by coordinates.
AxisType = 0 : The axis is defined by a geometric point, line or plane and with the same
direction.
AxisType = 1 : The axis direction is defined by the three coordinates x,y,z, of a vector, to
which the axis will always stay parallel.
AxisType = 2 : the axis is defined by a geometric point, line or plane and with the opposite
direction. Notice : If the Y axis is neither defined by coordinates nor by a
point,line or plane, the axis will be automatically computed in order to build an
orthogonal axis system with the other specified axes.

Example:
The following example prints the Y axis type :

Catia.SystemService.Print “ YAxisType = “ & axisSystem.YAxisType

The following example sets the Y axis type to 1 :

axisSystem.YAxisType = 1
Returns:

enum cat_axis_system_axis_type

Return type:

int

property z_axis_direction: Reference

Note

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

Reads or sets the geometric point, line or plane which defines the
direction of the Z axis.
AxisDirection is and must be a reference on a 3D point or 3D line or
plane.

Example:
The following example sets the point Point.1 of the Geometrical Set
Geometrical Set.1 as the direction of the Z axis of the axis system
AxisSystem0:

Dim HybridBody4 As AnyObject
Set HybridBody4 = Body1.HybridBodies.Item ( “Geometrical Set.1” )
Dim HybridShapePointCoord5 As AnyObject
Set HybridShapePointCoord5 = HybridBody4.HybridShapes.Item ( “Point.1” )
Dim Reference6 As Reference
Set Reference6 = CATIA.ActiveDocument.Part.
CreateReferenceFromGeometry(HybridShapePointCoord5)
AxisSystem0.ZAxisDirection = Reference6
Return type:

Reference

property z_axis_type: int

Note

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

Reads or sets the way the Z axis is specified.
An axis X,Y, or Z of the axis system can be defined by a geometric point,
line or plane, or by coordinates.
AxisType = 0 : The axis is defined by a geometric point, line or plane and with the same
direction.
AxisType = 1 : The axis direction is defined by the three coordinates x,y,z, of a vector, to
which the axis will always stay parallel.
AxisType = 2 : the axis is defined by a geometric point, line or plane and with the opposite
direction. Notice : If the Z axis is neither defined by coordinates nor by a
point,line or plane, the axis will be automatically computed in order to build an
orthogonal axis system with the other specified axes.

Example:
The following example prints the Z axis type :

Catia.SystemService.Print “ ZAxisType = “ & axisSystem.ZAxisType

The following example sets the Z axis type to 1 :

axisSystem.ZAxisType = 1
Returns:

enum cat_axis_system_axis_type

Return type:

int