GO2cam Javascript API  6.11
GO2SHole Class Reference

Hole object. More...

Inheritance diagram for GO2SHole:
GO2SSimpleGeometry GO2SWireGeometry GO2SGeometry

Public Member Functions

 GO2SHole ()
 Default constructor.
 
 GO2SHole (GO2SXYZ pos, GO2SXYZ normal, Number diam, Number depth, Boolean blind, Boolean bWithChamfer=false, Number diamChamfer=0)
 See GO2SHole.SetSimpleSmoothHole.
 
GO2SEnum::GO2SError SetSimpleCounterBoredHole (GO2SXYZ pos, GO2SXYZ normal, Number diam, Number depth, Boolean blind, Number diamLamage, Number depthLamage, Boolean bWithChamfer=false, Number diamChamfer=0)
 
GO2SEnum::GO2SError SetSimpleSmoothHole (GO2SXYZ pos, GO2SXYZ normal, Number diam, Number depth, Boolean blind, Boolean bWithChamfer=false, Number diamChamfer=0)
 
GO2SEnum::GO2SError SetSimpleSmoothHoleFlatEnd (GO2SXYZ pos, GO2SXYZ normal, Number diam, Number depth, Boolean bWithChamfer=false, Number diamChamfer=0)
 
GO2SEnum::GO2SError SetSimpleTappedHole (GO2SXYZ pos, GO2SXYZ normal, Number diam, Number depth, Boolean blind, Number pas, Number diamInt, Number depthInt, Boolean bWithChamfer=false, Number diamChamfer=0)
 
- Public Member Functions inherited from GO2SSimpleGeometry
Array< GO2SGeometryCut (GO2SXYZ pt)
 
GO2SXYZ GetCenterPoint ()
 
GO2SXYZ GetDirectionOnCurve (Number t)
 Deprecated, use GetTangentOnCurve.
 
GO2SXYZ GetFirstPoint () override
 
GO2SXYZ GetLastPoint () override
 
Number GetLength () override
 
GO2SXYZ GetMidPoint ()
 
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
 
GO2SGeometry Trim (Boolean keepStart, GO2SXYZ endTrim)
 
- 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

Hole object.

var p1 = new GO2SXYZ(10,10,0)
var p2 = new GO2SXYZ(10,100,0)
var seg = new GO2SSegment(p1,p2)
// blind hole diam 10, h 20
var hole = new GO2SHole(new GO2SXYZ(),new GO2SXYZ(0,0,1), 10, 20, true);
hole.SetPosition(seg.GetLastPoint());

Member Function Documentation

◆ SetSimpleCounterBoredHole()

GO2SEnum::GO2SError GO2SHole::SetSimpleCounterBoredHole ( GO2SXYZ pos,
GO2SXYZ normal,
Number diam,
Number depth,
Boolean blind,
Number diamLamage,
Number depthLamage,
Boolean bWithChamfer = false,
Number diamChamfer = 0 )

Create a counter bored hole

Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]poshole position
[in]normalhole normal
[in]diamhole diameter
[in]depthhole depth
[in]blindtrue if the hole is blind
[in]diamLamagelamage diameter
[in]depthLamagelamage depth
[in]bWithChamfertrue if the hole have a chamfer
[in]diamChamferchamfer diameter

◆ SetSimpleSmoothHole()

GO2SEnum::GO2SError GO2SHole::SetSimpleSmoothHole ( GO2SXYZ pos,
GO2SXYZ normal,
Number diam,
Number depth,
Boolean blind,
Boolean bWithChamfer = false,
Number diamChamfer = 0 )

Create a hole

Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]poshole position
[in]normalhole normal
[in]diamhole diameter
[in]depthhole depth
[in]blindtrue if the hole is blind
[in]bWithChamfertrue if the hole have a chamfer
[in]diamChamferchamfer diameter

◆ SetSimpleSmoothHoleFlatEnd()

GO2SEnum::GO2SError GO2SHole::SetSimpleSmoothHoleFlatEnd ( GO2SXYZ pos,
GO2SXYZ normal,
Number diam,
Number depth,
Boolean bWithChamfer = false,
Number diamChamfer = 0 )

Create a hole with flat end

Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]poshole position
[in]normalhole normal
[in]diamhole diameter
[in]depthhole depth
[in]bWithChamfertrue if the hole have a chamfer
[in]diamChamferchamfer diameter

◆ SetSimpleTappedHole()

GO2SEnum::GO2SError GO2SHole::SetSimpleTappedHole ( GO2SXYZ pos,
GO2SXYZ normal,
Number diam,
Number depth,
Boolean blind,
Number pas,
Number diamInt,
Number depthInt,
Boolean bWithChamfer = false,
Number diamChamfer = 0 )

Create a tapped hole

Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]poshole position
[in]normalhole normal
[in]diamhole diameter
[in]depthhole depth
[in]blindtrue if the hole is blind
[in]pastapping
[in]diamIntdrilling diameter
[in]depthIntheight tapping
[in]bWithChamfertrue if the hole have a chamfer
[in]diamChamferchamfer diameter