DLL Function

int CCI_Return = ScSetDoubleValue(int Value_Type, double Parameter)

double Parameter = ScGetDoubleValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetDoubleValue(int Value_Type, double Parameter)

double Parameter = ScCciGetDoubleValue(int Value_Type)

Description

Set or get global Nudge Step.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeNudgeX

164

Nudge step size in x-direction.

scComSAMLightClientCtrlDoubleValueTypeNudgeY

165

Nudge step size in y-direction.

Parameter

Type: double

Unit: [mm]*

The desired value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

The default unit is mm, but the user can select a different unit.

C# Example: Set nudge step size in x-direction to 20.0mm:

int CCI_Return = cci.ScSetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeNudgeX, 20.0 );

C# Example: Get current nudge step size in x-direction:

double Nudge_X = cci.ScGetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueTypeNudgeX);

DLL Function

int CCI_Return = ScSetLongValue(int Value_Type, int Flag)

int Flag = ScGetLongValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetLongValue(int Value_Type, int Flag)

int Flag = ScCciGetLongValue(int Value_Type)

Description

This function can be used to set or get the current state of the SAMLight toolbars.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeShowToolBars

103

Flag

Type: int

Flag:

Location: None

SC_SHOW_TOOLBAR_MAIN

0x1

The main toolbar includes such functions, as Open File, Save Job, undo, redo and so on. It corresponds to the file toolbar in the toolbar settings.

SC_SHOW_TOOLBAR_CAMERA

0x2

Background camera toolbar.

SC_SHOW_TOOLBAR_VIEW_LEVEL

0x4

View level toolbar provides two arrow buttons for increasing or decreasing the

view level of the entity list.

SC_SHOW_TOOLBAR_FUNC_OBJECTS

0x8

The functionality objects toolbar includes timer, wait for trigger and other control objects, some entity objects such as date time or serial number and data wizard and parameter finder.

SC_SHOW_TOOLBAR_ALIGN

0x10

Align toolbar containing object alignment settings.

SC_SHOW_TOOLBAR_GEOM_OBJECTS

0x20

Geometry objects toolbar.

SC_SHOW_TOOLBAR_EXTRAS

0x40

Extras toolbar, containing the splitting, step/repeat and bitmap splitting settings.

SC_SHOW_TOOLBAR_STEPPER

0x80

Stepper position toolbar.

SC_SHOW_TOOLBAR_SURFACE

0x100

3D surfaces toolbar. This toolbar is available only if the option Optic3D license is present.

SC_SHOW_TOOLBAR_ANALOG_IN

0x200

Analog In toolbar. Only available if USC-2/-3 is used.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The flags can be combined by using logical operators. Please refer to the chapter How to work with Flags for more information.

C# Example: Activate camera toolbars:

int CCI_Return = cci.ScSetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeShowToolBars, 0x2);

C# Example: Check camera toolbar state:

int Toolbar_State = cci.ScGetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeShowToolBars);