GO2SCircle Class Reference

Circle object. More...

Inheritance diagram for GO2SCircle:

Public Member Functions
	GO2SCircle ()
	Default constructor.
	GO2SCircle (GO2SXYZ p, Number radius)
	See GO2SCircle.SetFromRadius.
Number	GetRadius ()
GO2SEnum::GO2SError	SetConcentricByOffset (GO2SGeometry geom, Number offset)
GO2SEnum::GO2SError	SetConcentricByPoint (GO2SGeometry geom, GO2SXYZ p)
GO2SEnum::GO2SError	SetFrom2Points (GO2SXYZ p1, GO2SXYZ p2)
GO2SEnum::GO2SError	SetFrom3Points (GO2SXYZ p1, GO2SXYZ p2, GO2SXYZ p3)
GO2SEnum::GO2SError	SetFromRadius (GO2SXYZ p, Number radius)
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 ()
GO2SEnum::GO2SLineType	GetLineType ()
Number	GetLineWidth ()
String	GetName ()
Number	GetParam (GO2SEnum::GO2SParam param)
GO2SGeometry	GetParent ()
Number	GetPlane ()
GO2SXYZ	GetPosition ()
Boolean	IsCircular ()
Boolean	IsLinear ()
Boolean	IsMesh ()
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 (GO2SEnum::GO2SLineType 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

Circle object.

Member Function Documentation

GetRadius()

Number GO2SCircle::GetRadius

(

)

Returns

the radius of the circle

SetConcentricByOffset()

GO2SEnum::GO2SError GO2SCircle::SetConcentricByOffset	(	GO2SGeometry	geom,
		Number	offset )

Create the circle to be concentric to another one with an offset between them

Returns

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

Parameters

[in]	geom	the base circle or arc
[in]	offset	the offset value

SetConcentricByPoint()

GO2SEnum::GO2SError GO2SCircle::SetConcentricByPoint	(	GO2SGeometry	geom,
		GO2SXYZ	p )

Create the circle to be concentric to another passing through a point

Returns

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

Parameters

[in]	geom	the base circle or arc
[in]	p	a point of the new circle

SetFrom2Points()

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

Create the circle with a center and a point

Returns

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

Parameters

[in]	p1	the center of the circle
[in]	p2	a point of the circle

SetFrom3Points()

GO2SEnum::GO2SError GO2SCircle::SetFrom3Points	(	GO2SXYZ	p1,
		GO2SXYZ	p2,
		GO2SXYZ	p3 )

Create the circle from 3 points on the circle

Returns

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

Version

6.12

Parameters

[in]	p1	first point on the circle
[in]	p2	second point on the circle
[in]	p3	third point on the circle

SetFromRadius()

GO2SEnum::GO2SError GO2SCircle::SetFromRadius	(	GO2SXYZ	p,
		Number	radius )

Create the circle with a center and a radius

Returns

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

Parameters

[in]	p	the center of the circle
[in]	radius	the radius of the circle