GO2cam Javascript API
Public Member Functions | List of all members
GO2SPlane Class Reference
Geometry » Common geometry

Plane shape management. More...

Inheritance diagram for GO2SPlane:
GO2SGeometry

Public Member Functions

 GO2SPlane (Number no=MAXPLA)
 Default constructor.
 
GO2SEnum::GO2SError Delete () override
 Delete the plane.
 
GO2SEnum::GO2SError DevSetFrom1Point (GO2SXYZ geomRef, Boolean bInterior, Boolean bYMM, Boolean bInvertY, GO2SEnum::GO2SAxis axis, Boolean newPlane=true)
 
GO2SEnum::GO2SError DevSetFrom2Points (GO2SXYZ geomRef1, GO2SXYZ geomRef2, Boolean bInterior, Boolean bYMM, Boolean bInvertY, GO2SEnum::GO2SAxis axis, Boolean newPlane=true)
 
GO2SMatrix GetMatrix ()
 
Number GetNumber ()
 
GO2SEnum::GO2SError SetFrom3Points (GO2SXYZ origin, GO2SXYZ xAxis, GO2SXYZ yAxis, Boolean newPlane=true)
 
GO2SEnum::GO2SError SetFromAngle (GO2SXYZ origin, Number angle, GO2SEnum::GO2SAxis axis, Boolean newPlane=true)
 
GO2SEnum::GO2SError SetFromMatrix (GO2SMatrix matrix, Boolean newPlane=true)
 
- Public Member Functions inherited from GO2SGeometry
GO2SEnum::GO2SError ChangePlane (Number plane)
 
GO2SGeometry Copy ()
 
GO2SEnum::GO2SError Delete ()
 
Array< GO2SXYZ > Discretize (Number accuracy=0.01)
 
Boolean Equals (GO2SGeometry other)
 
Array< GO2SXYZ > GetBoundingBox ()
 
Number GetColor ()
 
Array< GO2SEnum::GO2SParam > GetEditableParams ()
 
Number GetLayer ()
 
GO2SEnum::GO2SLineType GetLineType ()
 
Number GetLineWidth ()
 
String GetName ()
 
Number GetParam (GO2SEnum::GO2SParam param)
 
GO2SGeometry GetParent ()
 
Number GetPlane ()
 
GO2SXYZ GetPosition ()
 
Boolean IsCircular ()
 
Boolean IsLinear ()
 
Boolean IsMesh ()
 
Boolean IsParamEditable (GO2SEnum::GO2SParam param)
 
Boolean IsPoint ()
 
Boolean IsPositionEditable ()
 
Boolean IsSolid ()
 
Boolean IsValid ()
 
Boolean IsVisible ()
 
Boolean IsWireframe ()
 
GO2SGeometry Rotated (GO2SXYZ xyz, Number angle, Boolean xyzDir)
 
GO2SEnum::GO2SError SetColor (Number color)
 
GO2SEnum::GO2SError SetLayer (Number layer)
 
GO2SEnum::GO2SError SetLineType (GO2SEnum::GO2SLineType type)
 
GO2SEnum::GO2SError SetLineWidth (Number width)
 
GO2SEnum::GO2SError SetName (String p1)
 
GO2SEnum::GO2SError SetParam (GO2SEnum::GO2SParam param, Number value)
 
GO2SEnum::GO2SError SetPlane (Number plane)
 
GO2SEnum::GO2SError SetPolarPosition (Number radius, Number angle, Number altitude=0)
 
GO2SEnum::GO2SError SetPosition (GO2SXYZpos)
 
GO2SEnum::GO2SError SetPosition (Number x, Number y, Number z)
 
GO2SEnum::GO2SError SetVisible (Boolean visibility)
 
String toString ()
 
GO2SEnum::GO2SError Transform (GO2SMatrix matrix)
 
GO2SGeometry Transformed (GO2SMatrix matrix)
 
GO2SGeometry Translated (GO2SXYZ origin, GO2SXYZ p)
 

Detailed Description

Plane shape management.

var pts = GO2SGeometryUtil.GetPoints()
let plan = new GO2SPlane
plan.SetFrom3Points(pts[0].toXYZ(), pts[1].toXYZ(), pts[2].toXYZ())
GO2SGeometryUtil.SetUsedPlane(plan.GetNumber())
new GO2SCircle(new GO2SXYZ(0, 0, 0), 20)
GO2SCircle
Circle object.
Definition GO2SCircle.hpp:8
GO2SGeometryUtil
Class for utilitary methods of geometric entities.
Definition GO2SGeometryUtil.hpp:11
GO2SGeometryUtil::GetPoints
static Array< GO2SGeometry > GetPoints(Number color=-1, Number layer=-1, Number plane=-1)
GO2SGeometryUtil::SetUsedPlane
static void SetUsedPlane(Number newPlane=-1)
Definition GO2SGeometryUtil.hpp:166
GO2SPlane
Plane shape management.
Definition GO2SPlane.hpp:21
GO2SPlane::SetFrom3Points
GO2SEnum::GO2SError SetFrom3Points(GO2SXYZ origin, GO2SXYZ xAxis, GO2SXYZ yAxis, Boolean newPlane=true)
GO2SXYZ
Creation of a coordinate reference.
Definition GO2SXYZ.hpp:89

Constructor & Destructor Documentation

◆ GO2SPlane()

GO2SPlane::GO2SPlane ( Number no = MAXPLA)

Default constructor.

Parameters
[in]nonumber of an existing plane number

Member Function Documentation

◆ DevSetFrom1Point()

GO2SEnum::GO2SError GO2SPlane::DevSetFrom1Point ( GO2SXYZ geomRef,
Boolean bInterior,
Boolean bYMM,
Boolean bInvertY,
GO2SEnum::GO2SAxis axis,
Boolean newPlane = true )

Create a developped plane from1point

Remarks
a new plane will be created in the database and the number of the plane will be updated
Returns
GO2SError.success (0) if success, see GO2SError otherwise
Version
6.12
Parameters
[in]geomRefpoint of reference for the plane
[in]bInteriorif the orientation is to the interior
[in]bYMMif the ordinate axis is in millimeters
[in]bInvertYif the Y axis is inverted
[in]axisrotation axis
[in]newPlanewhether to create a new plane or modify the current one

◆ DevSetFrom2Points()

GO2SEnum::GO2SError GO2SPlane::DevSetFrom2Points ( GO2SXYZ geomRef1,
GO2SXYZ geomRef2,
Boolean bInterior,
Boolean bYMM,
Boolean bInvertY,
GO2SEnum::GO2SAxis axis,
Boolean newPlane = true )

Create a developped plane from 2 points

Remarks
a new plane will be created in the database and the number of the plane will be updated
Returns
GO2SError.success (0) if success, see GO2SError otherwise
Version
6.12
Parameters
[in]geomRef1first point of reference for the plane
[in]geomRef2second point of reference for the plane
[in]bInteriorif the orientation is to the interior
[in]bYMMif the ordinate axis is in millimeters
[in]bInvertYif the Y axis is inverted
[in]axisrotation axis
[in]newPlanewhether to create a new plane or modify the current one

◆ GetMatrix()

GO2SMatrix GO2SPlane::GetMatrix ( )

Get the matrix associated with the plane

Returns
the matrix of the plane, or nullptr if no plane geometry exists
Version
2026

◆ GetNumber()

Number GO2SPlane::GetNumber ( )
inline
Returns
the number of the plane (Reference plane is number 1)

◆ SetFrom3Points()

GO2SEnum::GO2SError GO2SPlane::SetFrom3Points ( GO2SXYZ origin,
GO2SXYZ xAxis,
GO2SXYZ yAxis,
Boolean newPlane = true )

Create a plane from 3 points

Remarks
a new plane will be created in the database and the number of the plane will be updated
Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]originorigin of the plane
[in]xAxiscoordinates of a point in X axis of the plane
[in]yAxiscoordinates of a point in Y axis of the plane
[in]newPlanewhether to create a new plane or modify the current one

◆ SetFromAngle()

GO2SEnum::GO2SError GO2SPlane::SetFromAngle ( GO2SXYZ origin,
Number angle,
GO2SEnum::GO2SAxis axis,
Boolean newPlane = true )

Create a plane by rotating the current plane

Remarks
a new plane will be created in the database and the number of the plane will be updated
Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]originnew origin for the plane
[in]anglerotation angle in degree
[in]axisrotation axis
[in]newPlanewhether to create a new plane or modify the current one

◆ SetFromMatrix()

GO2SEnum::GO2SError GO2SPlane::SetFromMatrix ( GO2SMatrix matrix,
Boolean newPlane = true )

Use matrix to define a plane

Remarks
a new plane will be created in the database and the number of the plane will be updated
Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]matrixthe matrix defining the plane
[in]newPlanewhether to create a new plane or modify the current one