GO2SInteract Class Reference

Class to manage interactivity with GO2cam. More...

Inherits QObject.

Static Public Member Functions
static void	ClearAll (Boolean askSave=false)
	Reset GO2cam content (same than creating a new empty file)
static GO2SEnum::GO2SContext	GetCurrentContext ()
static GO2SEnum::GO2SEdgeDisplay	GetEdgeDisplay ()
static GO2SGeometry	PickEntity (String forcedMessage="")
static GO2SReference	PickReference (String forcedMessage="", GO2SEnum::GO2SPickReference type=GO2SEnum::GO2SPickReference::all)
static GO2SXYZ	PickXYZ (String forcedMessage="", Boolean info=false)
static GO2SXYZ	PickXYZWithPreview (Array< GO2SGeometry > preview, String forcedMessage="", Boolean info=false)
static void	Redraw (Boolean reframe=false)
	Force the 3D scene to be redrawn.
static void	SetCurrentContext (GO2SEnum::GO2SContext ctx)
static void	SetEdgeDisplay (GO2SEnum::GO2SEdgeDisplay disp)
static void	SetEntityVisible (GO2SEnum::GO2SFilterType type, GO2SEnum::GO2SFilterMode mode)
static void	SetLayerName (Number layerNo, String name)
static void	SetLayerVisible (Number layer, Boolean visible)
static void	StartSelection ()
	Ask for a selection in the 3D scene. When selection is done, selected elements can be retrieved with GO2SGeometryUtil::GetSelected()
static void	UpdateAll ()
	Update geometry and machining.
static void	UpdateGeometry ()
	Update geometry.
static void	UpdateMachining ()
	Update machining.

Detailed Description

Class to manage interactivity with GO2cam.

Member Function Documentation

ClearAll()

static void GO2SInteract::ClearAll ( Boolean askSave = false )

static

Reset GO2cam content (same than creating a new empty file)

Parameters

[in]

askSave

if true, ask to save the pce file before clear

GetCurrentContext()

static GO2SEnum::GO2SContext GO2SInteract::GetCurrentContext ( )

static

Get current GO2cam context

Warning

Allow to read the current context of GO2cam

Version

6.11.205

GetEdgeDisplay()

static GO2SEnum::GO2SEdgeDisplay GO2SInteract::GetEdgeDisplay ( )

static

Get the current option for edge display

Version

6.12

PickEntity()

static GO2SGeometry GO2SInteract::PickEntity ( String forcedMessage = "" )

static

Ask for an entity to be picked in the 3D scene When picking on a solid face or edge, returns the whole solid. To get faces or edges, see GO2SInteract.PickReference

Returns

A geometry

Parameters

[in]

forcedMessage

optional message to be displayed in the dialog bar

PickReference()

static GO2SReference GO2SInteract::PickReference ( String forcedMessage = "", GO2SEnum::GO2SPickReference type = GO2SEnum::GO2SPickReference::all )

static

Ask for an entity to be picked in the 3D scene. This function allows to get references on faces or edges when clicking on a solid.

Version

6.11.204

Returns

a reference on the entity (see GO2SReference.GetGeometry()).

Parameters

[in]	forcedMessage	optional message to be displayed in the dialog bar
[in]	type	type of reference to pick (point, edge or face) (Version 6.12)

PickXYZ()

static GO2SXYZ GO2SInteract::PickXYZ ( String forcedMessage = "", Boolean info = false )

static

Ask for XYZ to be picked in the 3D scene

Returns

Picked position

Parameters

[in]	forcedMessage	optional message to be displayed in the dialog bar
[in]	info	v6.12 whether to display coordinates next to cursor

PickXYZWithPreview()

static GO2SXYZ GO2SInteract::PickXYZWithPreview ( Array< GO2SGeometry > preview, String forcedMessage = "", Boolean info = false )

static

Ask for a point picked in the 3D scene + display a preview under the mouse

Remarks

the function automatically deletes the geometry given to make the preview

var preview = new GO2SCircle(new GO2SXYZ, 10)
var newPos = GO2SInteract.PickPointWithPreview([preview])
var circle = new GO2SCircle(newPos, 10)

Returns

Picked position

Parameters

[in]	preview	List of geometries to put under the mouse
[in]	forcedMessage	Optional message to be displayed in the dialog bar
[in]	info	Since version 6.12, whether to display coordinates next to cursor

Redraw()

static void GO2SInteract::Redraw ( Boolean reframe = false )

static

Force the 3D scene to be redrawn.

Parameters

[in]

reframe

if true, reframe the view

SetCurrentContext()

static void GO2SInteract::SetCurrentContext ( GO2SEnum::GO2SContext ctx )

static

Change GO2Cam context

Warning

Use to create a geometry or Opelist in milling or turning context

Version

6.11.205

Parameters

[in]

ctx

ctx new wanted context

SetEdgeDisplay()

static void GO2SInteract::SetEdgeDisplay ( GO2SEnum::GO2SEdgeDisplay disp )

static

Set the current option for edge display

Version

6.12

Parameters

[in]

disp

edge display mode

SetEntityVisible()

static void GO2SInteract::SetEntityVisible ( GO2SEnum::GO2SFilterType type, GO2SEnum::GO2SFilterMode mode )

static

Set visibility of entity types (ex: show or hide all circles)

Version

6.12

Parameters

[in]	type	type of entity to filter
[in]	mode	visibility

SetLayerName()

static void GO2SInteract::SetLayerName ( Number layerNo, String name )

static

Set the name of a layer

Version

6.11.205

Parameters

[in]	layerNo	layer number to rename
[in]	name	name of the layer

SetLayerVisible()

static void GO2SInteract::SetLayerVisible ( Number layer, Boolean visible )

static

Set the visibility of a given layer

Version

6.12

Parameters

[in]	layer	layer index
[in]	visible	whether the layer shoul be visible or not