pycatia.hybrid_shape_interfaces.plane

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.plane.Plane(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

Plane

Represents the hybrid shape Plane feature object.

Role: Declare hybrid shape Plane root feature object. All interfaces for

different type of Plane derives HybridShapePlane.

Use the CATIAHybridShapeFactory to create a HybridShapePlane

objects.

See also:

HybridShapeFactory

get_first_axis(o_first_axis: tuple) → None

Note

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

o Sub GetFirstAxis(CATSafeArrayVariant oFirstAxis)

Returns the coordinates of the first plane axis.

Parameters:

oFirstAxis[0]

The X Coordinate of the first plane axis

oFirstAxis[1]

The Y Coordinate of the first plane axis

oFirstAxis[2]

The Z Coordinate of the first plane axis

See also:

HybridShapeFactory

Parameters:

o_first_axis (tuple) –

Return type:

None

get_origin(o_origin: tuple) → None

Note

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

o Sub GetOrigin(CATSafeArrayVariant oOrigin)

Returns the origin of the plane.

Parameters:

oOrigin[0]

The X Coordinate of the plane origin

oOrigin[1]

The Y Coordinate of the plane origin

oOrigin[2]

The Z Coordinate of the plane origin

See also:

HybridShapeFactory

Parameters:

o_origin (tuple) –

Return type:

None

get_position(o_x: float, o_y: float, o_z: float) → None

Note

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

o Sub GetPosition(double oX,

double oY,

double oZ)

Gets the position where the plane is displayed.

Parameters:

oX

X coordinates

oY

Y coordinates

oZ

Z coordinates

Returns:

S_OK if the position has been set before, E_FAIL else.

Parameters:

• o_x (float) –

• o_y (float) –

• o_z (float) –

Return type:

None

get_second_axis(o_second_axis: tuple) → None

Note

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

o Sub GetSecondAxis(CATSafeArrayVariant oSecondAxis)

Returns the coordinates of the second plane axis.

Parameters:

oSecondAxis[0]

The X Coordinate of the second plane axis

oSecondAxis[1]

The Y Coordinate of the second plane axis

oSecondAxis[2]

The Z Coordinate of the second plane axis

See also:

HybridShapeFactory

Parameters:

o_second_axis (tuple) –

Return type:

None

is_a_ref_plane() → int

Note

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

o Func IsARefPlane() As long

Queries whether the plane is a reference plane (fixed axis

plane).

Returns:

0 when the plane is a reference plane, 1 else.

Return type:

int

put_first_axis(i_first_axis: tuple) → None

Note

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

o Sub PutFirstAxis(CATSafeArrayVariant iFirstAxis)

Sets the first axis. The first plane axis must be a point-direction

line.

Note: This method can only be used on CATIAHybridShapePlane2Lines

feature

Parameters:

iFirstAxis[0]

The X Coordinate of the first plane axis

iFirstAxis[1]

The Y Coordinate of the first plane axis

iFirstAxis[2]

The Z Coordinate of the first plane axis

See also:

HybridShapeFactory

Parameters:

i_first_axis (tuple) –

Return type:

None

put_origin(i_origin: tuple) → None

Note

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

o Sub PutOrigin(CATSafeArrayVariant iOrigin)

Sets the origin of the plane.

Note: This method can only be used on CATIAHybridShapePlane2Lines

feature

Parameters:

iOrigin[0]

The X Coordinate of the plane origin

iOrigin[1]

The Y Coordinate of the plane origin

iOrigin[2]

The Z Coordinate of the plane origin

See also:

HybridShapeFactory

Parameters:

i_origin (tuple) –

Return type:

None

put_second_axis(i_second_axis: tuple) → None

Note

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

o Sub PutSecondAxis(CATSafeArrayVariant iSecondAxis)

Sets the coordinates of the second plane axis. The second plane axis must

be a point-direction line

Note: This method can only be used on CATIAHybridShapePlane2Lines

feature

Parameters:

iSecondAxis[0]

The X Coordinate of the second plane axis

iSecondAxis[1]

The Y Coordinate of the second plane axis

iSecondAxis[2]

The Z Coordinate of the second plane axis

See also:

HybridShapeFactory

Parameters:

i_second_axis (tuple) –

Return type:

None

remove_position() → None

Note

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

o Sub RemovePosition()

Removes reference position of a plane.

Note: When removed, the plane is displayed at its default position.

Return type:

None

set_position(i_x: float, i_y: float, i_z: float) → None

Note

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

o Sub SetPosition(double iX,

double iY,

double iZ)

Sets the position where the plane is displayed.

Parameters:

iX

X coordinates

iY

Y coordinates

iZ

Z coordinates

Parameters:

• i_x (float) –

• i_y (float) –

• i_z (float) –

Return type:

None