pycatia.hybrid_shape_interfaces.hybrid_shape_point_on_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.hybrid_shape_point_on_plane.HybridShapePointOnPlane(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

CATGSMIDLItf.Point

HybridShapePointOnPlane

Point on a plane.

Role: Allows to access data of the point feature created on a plane with a

reference point or not.

See also:

Length, Reference, HybridShapeDirection, HybridShapeFactory

property first_direction: HybridShapeDirection

Note

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

o Property FirstDirection() As HybridShapeDirection

Returns or sets the first direction on the plane to compute the point (for

stability).

Example

:

This example retrieves in oDirection the direction of the PointOnPlane

feature.

Dim oDirection As CATIAHybridShapeDirection

Set oDirection = PointOnPlane.FirstDirection

Return type:

HybridShapeDirection

get_second_direction(o_dir_x: float, o_dir_y: float, o_dir_z: float) → None

Note

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

o Sub GetSecondDirection(double oDirX,

double oDirY,

double oDirZ)

Gets the second direction on the plane to compute the point (for

stability).

This direction has to be kept perpendicular to the first

direction

Parameters:

oDir

second direction

See also:

HybridShapeDirection

Parameters:

• o_dir_x (float) –

• o_dir_y (float) –

• o_dir_z (float) –

Return type:

None

property plane: Reference

Note

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

o Property Plane() As Reference

Returns or sets the support plane.

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

PlanarFace.

Example

:

This example retrieves in oPlane the supporting Plane for PointOnPlane

feature.

Dim oPlane As CATIAReference

Set oPlane = PointOnPlane.Plane

Return type:

Reference

property point: Reference

Note

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

o Property Point() As Reference

Returns or sets the reference point.

This data is not mandatory, if Point is

null, the projection of the origin point on the plane is

taken.

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

Example

:

This example retrieves in oPoint the reference point for PointOnPlane

feature.

Dim oPoint As CATIAReference

Set oPoint = PointOnPlane.Point

Return type:

Reference

property projection_surface: Reference

Note

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

o Property ProjectionSurface() As Reference

Returns or sets the projection surface to compute the

point.

Example

:

This example retrieves in oProjSur the projection surface of the

PointOnPlane feature.

Dim oProjSur As CATIAReference

Set oProjSur = PointOnPlane.ProjectionSurface

Return type:

Reference

set_second_direction(i_dir_x: float, i_dir_y: float, i_dir_z: float) → None

Note

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

o Sub SetSecondDirection(double iDirX,

double iDirY,

double iDirZ)

Sets the second direction on the plane to compute the point (for

stability).

This direction has to be kept perpendicular to the first

direction

Parameters:

iDir

second direction

See also:

HybridShapeDirection

Parameters:

• i_dir_x (float) –

• i_dir_y (float) –

• i_dir_z (float) –

Return type:

None

property x_offset: Length

Note

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

o Property XOffset() As Length (Read Only)

Returns the X cartesian coordinate in the plane.

Example

:

This example retrieves in oX the X coordinate for PointOnPlane

feature.

Dim oX As CATIALength

Set oX = PointOnPlane.XOffset

Return type:

Length

property y_offset: Length

Note

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

o Property YOffset() As Length (Read Only)

Returns the Y cartesian coordinate in the plane.

Example

:

This example retrieves in oY the Y coordinate for PointOnPlane

feature.

Dim oY As CATIALength

Set oY = PointOnPlane.YOffset

Return type:

Length