GO2SHelix Class Reference

Helix object. More...

Inheritance diagram for GO2SHelix:

Public Member Functions
	GO2SHelix ()
	Default constructor.
	GO2SHelix (GO2SXYZ center, GO2SXYZ start, Number stepSize, Number stepNumber, Boolean isTrigo=true)
	See GO2SHelix.SetFrom2Points.
Number	GetRadius ()
Number	GetStepNumber ()
Number	GetStepSize ()
Boolean	IsCCW ()
GO2SEnum::GO2SError	SetCCW (Boolean isCCW)
GO2SEnum::GO2SError	SetFrom2Points (GO2SXYZ center, GO2SXYZ start, Number stepSize, Number stepNumber, Boolean isCCW=true)
GO2SEnum::GO2SError	SetStepNumber (Number stepNumber)
GO2SEnum::GO2SError	SetStepSize (Number stepSize)
Public Member Functions inherited from GO2SSimpleGeometry
Array< GO2SGeometry >	Cut (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< GO2SXYZ >	Discretize (Number accuracy=0.01)
Boolean	Equals (GO2SGeometry other)
Array< GO2SXYZ >	GetBoundingBox ()
Number	GetColor ()
Array< GO2SEnum::GO2SParam >	GetEditableParams ()
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

Helix object.

var center = new GO2SXYZ(50,50,0)
var p = new GO2SXYZ(120,60,0)
var helix = new GO2SHelix(center, p, 10, 5.5, false)
 
var helix2 =helix.Copy()
helix2.SetParam(GO2SParam.radius, 20)
helix2.SetStepNumber(3)
helix2.SetStepSize(20)

Member Function Documentation

GetRadius()

Number GO2SHelix::GetRadius

(

)

Returns

the radius of the helix

GetStepNumber()

Number GO2SHelix::GetStepNumber

(

)

Returns

the step number of the helix

GetStepSize()

Number GO2SHelix::GetStepSize

(

)

Returns

the step size of the helix

IsCCW()

Boolean GO2SHelix::IsCCW

(

)

Returns

if the helix goes CCW

SetCCW()

GO2SEnum::GO2SError GO2SHelix::SetCCW

(

Boolean

isCCW

)

Set the direction of the helix (CCW or CW)

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

isCCW

the helix goes CCW (true) or CW (false)

SetFrom2Points()

GO2SEnum::GO2SError GO2SHelix::SetFrom2Points	(	GO2SXYZ	center,
		GO2SXYZ	start,
		Number	stepSize,
		Number	stepNumber,
		Boolean	isCCW = true )

Create an helix from 2 points

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]	center	the center of the helix
[in]	start	the starting point of the helix
[in]	stepSize	the height of a step
[in]	stepNumber	the number of steps
[in]	isCCW	the helix goes CCW (true) or CW (false)

SetStepNumber()

GO2SEnum::GO2SError GO2SHelix::SetStepNumber

(

Number

stepNumber

)

Set the step number of the helix

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

stepNumber

the number of steps

SetStepSize()

GO2SEnum::GO2SError GO2SHelix::SetStepSize

(

Number

stepSize

)

Set the step size of the helix

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

stepSize

the height of a step