GO2cam Javascript API  6.11
GO2SWireGeometry Class Referenceabstract

Intermediate class for all wire geometry. More...

Inheritance diagram for GO2SWireGeometry:
GO2SGeometry GO2SMultipleGeometry GO2SSimpleGeometry GO2SOblong GO2SOffsetCurve GO2SPolygon GO2SProfile GO2SRectangle GO2SText GO2SWireFeature GO2SArc GO2SChamfer GO2SCircle GO2SEllipse GO2SFillet GO2SHelix GO2SHole GO2SLine GO2SNurbs GO2SPoint GO2SPolyline GO2SSegment

Public Member Functions

GO2SXYZ GetFirstPoint ()=0
 
GO2SXYZ GetLastPoint ()=0
 
Number GetLength ()=0
 
GO2SXYZ GetNormalOnCurve (Number t)=0
 
GO2SXYZ GetPositionOnCurve (Number t)=0
 
GO2SXYZ GetProjPoint (GO2SXYZ point)=0
 
Number GetT (GO2SXYZ point)=0
 
GO2SXYZ GetTangentOnCurve (Number t)=0
 
Boolean IsClose ()=0
 
- 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

Intermediate class for all wire geometry.

Member Function Documentation

◆ GetFirstPoint()

GO2SXYZ GO2SWireGeometry::GetFirstPoint ( )
pure virtual
Returns
the first point of the geometry (the first point of the first element in case of multiple geometry)

Implemented in GO2SMultipleGeometry, and GO2SSimpleGeometry.

◆ GetLastPoint()

GO2SXYZ GO2SWireGeometry::GetLastPoint ( )
pure virtual
Returns
the last point of the geometry (the last point of the last element in case of multiple geometry)

Implemented in GO2SMultipleGeometry, and GO2SSimpleGeometry.

◆ GetLength()

Number GO2SWireGeometry::GetLength ( )
pure virtual
Returns
the full length of the geometry (sum of all entities length in case of multiple geometry)

Implemented in GO2SMultipleGeometry, and GO2SSimpleGeometry.

◆ GetNormalOnCurve()

GO2SXYZ GO2SWireGeometry::GetNormalOnCurve ( Number t)
pure virtual
Returns
the normal on a geometry. In case of GO2SMultipleGeometry, the geometry must be continuous.
Version
6.11.206
Parameters
[in]tposition [0,1] on the geometry where to get the xyz coordinates, with 0 for 1st point and 1 for last point

Implemented in GO2SMultipleGeometry, and GO2SSimpleGeometry.

◆ GetPositionOnCurve()

GO2SXYZ GO2SWireGeometry::GetPositionOnCurve ( Number t)
pure virtual
Returns
the position on a geometry. In case of GO2SMultipleGeometry, the geometry must be continuous.
Parameters
[in]tposition [0,1] on the geometry where to get the xyz coordinates, with 0 for 1st point and 1 for last point

Implemented in GO2SMultipleGeometry, and GO2SSimpleGeometry.

◆ GetProjPoint()

GO2SXYZ GO2SWireGeometry::GetProjPoint ( GO2SXYZ point)
pure virtual

Compute the projection of a point on the wire geometry

Warning
No construction history is attached, only xyz coordinates are computed

Implemented in GO2SMultipleGeometry, and GO2SSimpleGeometry.

◆ GetT()

Number GO2SWireGeometry::GetT ( GO2SXYZ point)
pure virtual
Returns
the t position at a given position (xyz). 0 corresponds to the first point of the geometry, 1 to the last point. if an error occurred, returns -1
Version
6.11.206
Parameters
[in]pointposition (xyz) on the geometry where to get the t parameter

Implemented in GO2SMultipleGeometry, and GO2SSimpleGeometry.

◆ GetTangentOnCurve()

GO2SXYZ GO2SWireGeometry::GetTangentOnCurve ( Number t)
pure virtual
Returns
the tangent on a geometry. In case of GO2SMultipleGeometry, the geometry must be continuous.
Version
6.11.206
Parameters
[in]tposition [0,1] on the geometry where to get the xyz coordinates, with 0 for 1st point and 1 for last point

Implemented in GO2SMultipleGeometry, and GO2SSimpleGeometry.

◆ IsClose()

Boolean GO2SWireGeometry::IsClose ( )
pure virtual
Returns
if the geometry is closed

Implemented in GO2SMultipleGeometry, and GO2SSimpleGeometry.