pycatia.hybrid_shape_interfaces.hybrid_shape_plane_equation

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_plane_equation.HybridShapePlaneEquation(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.Plane
HybridShapePlaneEquation

Plane define by an equation plane.
Role: Allows to access data of the plane feature created by its cartesian equation.
Plane equation is Ax+By+Cz = D.
property a: RealParam

Note

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

Gets A coefficient for plane equation.

Parameters:

oA
A Coefficient of cartesian plane

See also:
RealParam
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++
Implementations
See also:
HybridShapeFactory
Return type:

RealParam

property b: RealParam

Note

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

Gets B coefficient for plane equation.

Parameters:

oB
B Coefficient of cartesian plane

See also:
RealParam
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++
Implementations
See also:
HybridShapeFactory
Return type:

RealParam

property c: RealParam

Note

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

Gets C coefficient for plane equation.

Parameters:

oC
C Coefficient of cartesian plane return value for CATScript
applications, with (IDLRETVAL) function type

See also:
RealParam
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++
Implementations
See also:
HybridShapeFactory
Return type:

RealParam

property d: Length

Note

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

Gets D coefficient for plane equation.

Parameters:

oD
D Coefficient of cartesian plane

See also:
Length
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++
Implementations
See also:
HybridShapeFactory
Return type:

Length

get_reference_point() → Reference

Note

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

Gets the reference point.

Parameters:

oReferencePoint
reference point
Return type:

Reference

property ref_axis_system: Reference

Note

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

Returns or Sets the reference Axis System for PlaneEquation
feature.
This data is not mandatory, if element is null, the absolute axis system is
taken.
When an element is given, X, Y and Z are considered in this Axis
system.
If reference point is not specified, X,Y and Z are measured from origin of
this axis system.

Example
:
This example retrieves in oRefAxis the reference Axis System for
PlaneEquation feature.

Dim oRefAxis As CATIAReference
Set oRefAxis = PlaneEquation.RefAxisSystem
Return type:

Reference

set_reference_point(i_reference_point: Reference) → None

Note

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

Sets the reference point.

Parameters:

iReferencePoint
reference point
Parameters:

i_reference_point (Reference) –

Return type:

None