GO2cam Javascript API  6.11
GO2SRectangle Class Reference

Rectangle object. More...

Inheritance diagram for GO2SRectangle:
GO2SMultipleGeometry GO2SWireGeometry GO2SGeometry

Public Member Functions

 GO2SRectangle ()
 Default constructor.
 
 GO2SRectangle (GO2SXYZ center, Number len, Number wid, Number ang)
 See GO2SRectangle.SetFromCenter.
 
 GO2SRectangle (GO2SXYZ pt1, GO2SXYZ pt2)
 See GO2SRectangle.SetFrom2Points.
 
GO2SEnum::GO2SError SetFrom2Points (GO2SXYZ pt1, GO2SXYZ pt2)
 
GO2SEnum::GO2SError SetFromCenter (GO2SXYZ center, Number len, Number wid, Number ang)
 
- Public Member Functions inherited from GO2SMultipleGeometry
Array< GO2SGeometryExplode ()
 
Number GetElementCount ()
 
GO2SXYZ GetFirstPoint () override
 
GO2SXYZ GetLastPoint () override
 
Number GetLength () override
 
GO2SXYZ GetNormalOnCurve (Number t) override
 
GO2SXYZ GetPositionOnCurve (Number t) override
 
GO2SXYZ GetProjPoint (GO2SXYZ point) override
 
Number GetT (GO2SXYZ point) override
 
GO2SXYZ GetTangentOnCurve (Number t) override
 
Boolean IsClose () override
 
- Public Member Functions inherited from GO2SGeometry
GO2SEnum::GO2SError ChangePlane (Number plane)
 
GO2SGeometry Copy ()
 
GO2SEnum::GO2SError Delete ()
 
Array< GO2SXYZDiscretize (Number accuracy=0.01)
 
Boolean Equals (GO2SGeometry other)
 
Array< GO2SXYZGetBoundingBox ()
 
Number GetColor ()
 
Array< GO2SEnum::GO2SParamGetEditableParams ()
 
Number GetLayer ()
 
Number GetLineType ()
 
Number GetLineWidth ()
 
String GetName ()
 
Number GetParam (GO2SEnum::GO2SParam param)
 
GO2SGeometry GetParent ()
 
Number GetPlane ()
 
GO2SXYZ GetPosition ()
 
Boolean IsCircular ()
 
Boolean IsLinear ()
 
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 (ELineType 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

Rectangle object.

Member Function Documentation

◆ SetFrom2Points()

GO2SEnum::GO2SError GO2SRectangle::SetFrom2Points ( GO2SXYZ pt1,
GO2SXYZ pt2 )

Set a rectangle from two points. The bottom of the rectangle is parallel to x axis

Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]pt11st point of the diagonal
[in]pt22nd point of the diagonal

◆ SetFromCenter()

GO2SEnum::GO2SError GO2SRectangle::SetFromCenter ( GO2SXYZ center,
Number len,
Number wid,
Number ang )

Set a rectangle from a center points

Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]centercenter of the rectangle
[in]lenlength
[in]widwidth
[in]angangle in degree from x axis