Stock object. More...

Inheritance diagram for GO2SStock:

Public Member Functions
	GO2SStock ()
	Create an empty stock object.

GO2SEnum::GO2SError	CreateMillingCuboid (Number lenght, Number width, Number height, GO2SXYZ pos)

GO2SEnum::GO2SError	CreateMillingCylinder (Number height, Number radius, GO2SXYZ pos, GO2SEnum::GO2SAxis axis)

GO2SEnum::GO2SError	CreateMillingSolid (GO2SSolidGeometry solid)

GO2SEnum::GO2SError	CreateTurning (Number length, Number diameter, Number origine, Number innerDiameter=0, Number nbSides=0)

GO2SEnum::GO2SError	CreateTurningProfile (GO2SProfile profile)

GO2SEnum::GO2SError	GetExistingStock ()

GO2SEnum::GO2SError	SetBarLength (Number length)

GO2SEnum::GO2SError	SetInterSafetyArea (GO2SEnum::GO2SSafetyArea shape, GO2SEnum::GO2SAxis direction, Number movezone, Number val1, Number val2)

GO2SEnum::GO2SError	SetMainSafetyArea (GO2SXYZ position, GO2SEnum::GO2SSafetyArea shape, GO2SEnum::GO2SAxis direction, Number movezone, Number val1, Number val2)

Public Member Functions inherited from GO2SSolidGeometry
GO2SMultipleGeometry	CreateSilhouette (GO2SXYZ direction, Number altitude, Number tolerance=0.01)

GO2SMultipleGeometry	CreateSilhouetteRevolution (GO2SXYZ direction, GO2SEnum::GO2SSilhouetteType type, Number tolerance)
	Given a direction, creates a revolution silhouette from a Solid.

GO2SMultipleGeometry	CreateSlice (GO2SXYZ direction, Number altitude, Number tolerance=0.01)
	Given a direction, creates a slice on the solid at a given altitude.

GO2SGeometry	ExtractEdge (GO2SEdge edge, Number tol=0.01)
	Extract a curve from an edge of a solid.

GO2SXYZ	GetExtrema (GO2SXYZ dir1, GO2SXYZ dir2, GO2SXYZ dir3)

GO2SMatrix	GetPrincipalAxes ()

Number	GetSurface ()

Number	GetVolume ()

GO2SMesh	ToMesh (Number tol=0.1)

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	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 (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

Stock object.

Member Function Documentation

◆ CreateMillingCuboid()

GO2SEnum::GO2SError GO2SStock::CreateMillingCuboid	(	Number	lenght,
		Number	width,
		Number	height,
		GO2SXYZ	pos )

Create a cuboid stock for milling

var pos = new GO2SXYZ(0,0,-50)
var stock = new GO2SStock
stock.CreateMillingCuboid(100, 80, 50, pos)

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

Remarks: if a stock already exists, it will be replaced

Parameters

[in]	lenght	length of the stock (dimension along X axis)
[in]	width	width of the stock (dimension along Y axis)
[in]	height	height of the stock (dimension along Z axis)
[in]	pos	position of the center of the bottom face of the stock

◆ CreateMillingCylinder()

GO2SEnum::GO2SError GO2SStock::CreateMillingCylinder	(	Number	height,
		Number	radius,
		GO2SXYZ	pos,
		GO2SEnum::GO2SAxis	axis )

Create a cylinder stock for milling

var pos = new GO2SXYZ
var stock = new GO2SStock
stock.CreateMillingCylinder(100, 30, pos, GO2SAxis.z)

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

Remarks: if a stock already exists, it will be replaced

Parameters

[in]	height	height of the stock (dimension along axis)
[in]	radius	radius of the stock
[in]	pos	position of the center of the bottom face of the stock (axis origin)
[in]	axis	axis of the cylinder

◆ CreateMillingSolid()

GO2SEnum::GO2SError GO2SStock::CreateMillingSolid ( GO2SSolidGeometry solid )

Create a milling stock from an existing solid

var pos = new GO2SXYZ
var cone = GO2SSolidCreate.Cone(pos, 100, 50, 80)
var stock = new GO2SStock
stock.CreateMillingSolid(cone)

Returns: GO2SError.<success (0) if success, see GO2SError otherwise

Remarks: if a stock already exists, it will be replaced; the solid will be deleted

Parameters

[in] solid the solid

◆ CreateTurning()

GO2SEnum::GO2SError GO2SStock::CreateTurning	(	Number	length,
		Number	diameter,
		Number	origine,
		Number	innerDiameter = 0,
		Number	nbSides = 0 )

Create a turning stock from a profile

Returns: GO2SError.<success (0) if success, see GO2SError otherwise

Remarks: if a stock already exists, it will be replaced

Version: 6.11.205

Parameters

[in]	length	length of the stock
[in]	diameter	radius of the stock
[in]	origine	origine of the stock along revolution axis
[in]	innerDiameter	inner diameter
[in]	nbSides	number of sides. If 0, the stock is a cylinder

◆ CreateTurningProfile()

GO2SEnum::GO2SError GO2SStock::CreateTurningProfile ( GO2SProfile profile )

Create a turning stock, cylinder or regular polygon

Returns: GO2SError.<success (0) if success, see GO2SError otherwise

Remarks: if a stock already exists, it will be replaced

Parameters

[in] profile the profile

◆ GetExistingStock()

GO2SEnum::GO2SError GO2SStock::GetExistingStock ( )

Get the existing stock

var stock = new GO2SStock
stock.GetExistingStock()
stock.SetParam(GO2SParam.length, 200)
GO2SInteract.UpdateAll()

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

◆ SetBarLength()

GO2SEnum::GO2SError GO2SStock::SetBarLength ( Number length )

Set the length of a swiss machining stock

Remarks: this function must be called once the stock created or get with GetExistingStock

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

Version: 6.12

Parameters

[in] length length of the stock

◆ SetInterSafetyArea()

GO2SEnum::GO2SError GO2SStock::SetInterSafetyArea	(	GO2SEnum::GO2SSafetyArea	shape,
		GO2SEnum::GO2SAxis	direction,
		Number	movezone,
		Number	val1,
		Number	val2 )

Set the intermediate safety area around the stock. See SetMainSafetyArea

Version: 6.12

◆ SetMainSafetyArea()

GO2SEnum::GO2SError GO2SStock::SetMainSafetyArea	(	GO2SXYZ	position,
		GO2SEnum::GO2SSafetyArea	shape,
		GO2SEnum::GO2SAxis	direction,
		Number	movezone,
		Number	val1,
		Number	val2 )

Set the main safety area around the stock

Remarks: this function must be called once the stock created or get with GetExistingStock

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

Version: 6.12

Parameters

[in]	position	origin of the safety area
[in]	shape	shape of the safety area
[in]	direction	direction of the safety area
[in]	movezone	movement : 1 Z machining, 2 Perpendicular
[in]	val1	Radius (for cylinder or sphere) or distance (for workplanes)
[in]	val2	Length if cylinder shape

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateMillingCuboid()

◆ CreateMillingCylinder()

◆ CreateMillingSolid()

◆ CreateTurning()

◆ CreateTurningProfile()

◆ GetExistingStock()

◆ SetBarLength()

◆ SetInterSafetyArea()

◆ SetMainSafetyArea()