GO2SSegment Class Reference

Segment object. More...

Inheritance diagram for GO2SSegment:

Public Member Functions
	GO2SSegment ()
	Default constructor.
	GO2SSegment (GO2SXYZ p1, GO2SXYZ dir, Number length)
	See GO2SSegment.SetFrom2DirAndLength.
	GO2SSegment (GO2SXYZ p1, GO2SXYZ p2)
	See GO2SSegment.SetFrom2Points.
GO2SEnum::GO2SError	SetFrom2Points (GO2SXYZ p1, GO2SXYZ p2)
GO2SEnum::GO2SError	SetFromDirAndLength (GO2SXYZ p1, GO2SXYZ dir, Number length)
GO2SEnum::GO2SError	SetPerpendicularTo (GO2SXYZ p, GO2SGeometry geom)
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

Segment object.

Member Function Documentation

SetFrom2Points()

GO2SEnum::GO2SError GO2SSegment::SetFrom2Points	(	GO2SXYZ	p1,
		GO2SXYZ	p2 )

Create a segment from 2 points

Returns

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

Parameters

[in]	p1	the starting point
[in]	p2	the end point

SetFromDirAndLength()

GO2SEnum::GO2SError GO2SSegment::SetFromDirAndLength	(	GO2SXYZ	p1,
		GO2SXYZ	dir,
		Number	length )

Create from a start, a direction and a length

Returns

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

Parameters

[in]	p1	the starting point
[in]	dir	the direction of the segment
[in]	length	the length in mm

SetPerpendicularTo()

GO2SEnum::GO2SError GO2SSegment::SetPerpendicularTo	(	GO2SXYZ	p,
		GO2SGeometry	geom )

Create the segment to be perpendicular to a line or another segment passing through a point

Returns

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

Parameters

[in]	p	the point
[in]	geom	the segment or the line which is perpendicular to