GO2cam Javascript API  6.11
GO2SProfile Class Reference

Profile object. More...

Inheritance diagram for GO2SProfile:
GO2SMultipleGeometry GO2SWireGeometry GO2SGeometry

Public Member Functions

 GO2SProfile ()
 Default constructor.
 
 GO2SProfile (GO2SGeometry start, GO2SGeometry end)
 See GO2SProfile.SetFrom2Geom.
 
GO2SEnum::GO2SError SetFrom2Geom (GO2SGeometry start, GO2SGeometry end)
 
GO2SEnum::GO2SError SetFromMultiGeom (GO2SMultipleGeometry feature)
 
- 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

Profile object.

var seg1 = new GO2SSegment(new GO2SXYZ, new GO2SXYZ(15,15,0))
var seg2 = new GO2SSegment(seg1.GetLastPoint(), new GO2SXYZ(40,15,0))
var seg3 = new GO2SSegment(seg2.GetLastPoint(), new GO2SXYZ(40,40,0))
var prf =new GO2SProfile(seg1,seg3)
var len1 = seg1.GetLength() + seg2.GetLength() + seg3.GetLength()
var len2 = prf.GetLength()
console.log('geometry length: '+ len1)
console.log('profile length: '+ len2)

Member Function Documentation

◆ SetFrom2Geom()

GO2SEnum::GO2SError GO2SProfile::SetFrom2Geom ( GO2SGeometry start,
GO2SGeometry end )

Compute a profile from two GO2SGeometry

Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]startStart of the profile
[in]endEnd of the profile

◆ SetFromMultiGeom()

GO2SEnum::GO2SError GO2SProfile::SetFromMultiGeom ( GO2SMultipleGeometry feature)

Compute a profile from one GO2SMultipleGeometry

Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]featurethe multi wire geometry (rectangle, polygon...)