DLL Function

int CCI_Return = ScSetLongValue(int Value_Type, int Enable_3D_Surface)

int Enable_3D_Surface = ScGetLongValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetLongValue(int Value_Type, int Enable_3D_Surface)

int Enable_3D_Surface = ScCciGetLongValue(int Value_Type)

Description

Set or get the 3D Surface enable state.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeEnable3DSurface

87

Enable_3D_Surface

Type: int

Unit: none

•0: 3D Surfaces disabled.

•1: 3D Surfaces enabled.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Enable 3D Surface:

int CCI_Return = cci.ScSetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeEnable3DSurface, 1 );

C# Example: Get current 3D Surface enable state:

int Enable_3D_Surface = cci.ScGetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeEnable3DSurface );

DLL Function

int CCI_Return = ScSetLongValue(int Value_Type, int Mode_3D_Surface)

int Mode_3D_Surface = ScGetLongValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetLongValue(int Value_Type, int Mode_3D_Surface)

int Mode_3D_Surface = ScCciGetLongValue(int Value_Type)

Description

Set or get the 3D Surface mode.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueType3DSurfaceSetType

86

Mode_3D_Surface

Type: int

Unit: none

•0: Cylinder (Cylinder properties)

•1: STL projection (STL projection properties, STL path)

•2: Tilted surface (Tilted surface properties)

•3: Sphere (Sphere properties)

CCI_Return

Type: int

CCI return number, see error list.

Notes

•3D Surface enable must be set.

C# Example: Set the 3D Surface mode to sphere:

int CCI_Return = cci.ScSetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueType3DSurfaceSetType, 3 );

C# Example: Get current 3D Surface mode:

int Mode_3D_Surface = cci.ScGetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueType3DSurfaceSetType );

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 various cylinder parameter.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1

96

X position [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue2

97

Y position [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue3

98

Z offset [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue4

99

XY angle [deg].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue5

100

Diameter / 2 [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue6

101

Line splitting length [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue7

102

Tube angle [deg].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue8

103

Z tilt angle [deg].

Parameter

Type: double

Unit: depends on constant

The corresponding value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•3D Surfaces type must be set to cylinder.

C# Example: Set cylinder X position to 0.0 mm:

int CCI_Return = cci.ScSetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1, 0.0 );

C# Example: Get current cylinder X position:

double Cylinder_X_Position = cci.ScGetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1 );

DLL Function

int CCI_Return = ScSetStringValue(int Value_Type, string Screenshot_Path)

ASCII Function

int CCI_Return = ScCciSetStringValue(int Value_Type, string Screenshot_Path)

Description

Export 3D vectors, that are wrapped / projected on 3D surfaces, as separate job.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeExport3dTransformed

42

Screenshot_Path

Type: string

Unit: none

Defines the path, where the .sjf is saved to. The path must include the job name.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•For the exported job, the original 3D surface is no longer needed.

•The exported vectors can be freely modified.

C# Example: Export 3D vectors:

int CCI_Return = cci.ScSetStringValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeExport3dTransformed, @"F:\testexp.sjf" );

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 various sphere parameter.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1

96

X position [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue2

97

Y position [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue3

98

Z offset [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue4

99

Line splitting length [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue5

100

Sphere angle [deg].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue6

101

Diameter [mm].

Parameter

Type: double

Unit: depends on constant

The corresponding value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•3D Surfaces type must be set to sphere.

C# Example: Set sphere X position to 0.0 mm:

int CCI_Return = cci.ScSetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1, 0.0 );

C# Example: Get current sphere X position

double Sphere_X_Position = cci.ScGetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1 );

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 various Tilted surface parameter.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1

96

X position [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue2

97

Y position [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue3

98

Z offset [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue4

99

XY angle [deg].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue5

100

Z tilt angle [deg].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue6

101

Width [mm]. Use '-1.0' for an infinite surface.

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue7

102

Heigth [mm]. Use '-1.0' for an infinite surface.

Parameter

Type: double

Unit: depends on constant

The corresponding value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•3D Surfaces type must be set to tilted surface.

C# Example: Set tilted surface X position to 0.0 mm:

int CCI_Return = cci.ScSetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1, 0.0 );

C# Example: Get current tilted surface X position:

double Tilted_Surface_X_Position = cci.ScGetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1 );

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 various STL projection parameter.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1

96

Center in field: ('0.0' for disabled, '1.0' for enabled).

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue2

97

X offset [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue3

98

Y offset [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue4

99

Z offset [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue5

100

XY rotation [deg].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue6

101

Line splitting length [mm].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue7

102

X scale.

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue8

103

Y scale.

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue9

104

Z scale.

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue10

105

ZX rotaion [deg].

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue11

106

ZY rotation [deg]. Please note that this Rotation (Rotation around the X-Axis) is in negative direction.

scComSAMLightClientCtrlDoubleValueType3DSurfaceValue12

107

Set checkbox 'Rotate around STL Origin'.

•0.0: Disable

•1.0: Enable

Parameter

Type: double

Unit: depends on constant

The corresponding value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•3D Surfaces type must be set to STL projection.

•To apply the changes sent by this command, the command STL Path needs to be sent afterwards using the string "REAPPLY"

•Most rotations in SAMLight are in positive direction. Positive rotations are counter-clockwise when the axis of rotation points towards us.

C# Example: Enable center in field:

int CCI_Return = cci.ScSetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1, 1.0 );

C# Example: Get current center in field enable state:

double Enable_Center_In_Field = cci.ScGetDoubleValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlDoubleValueType3DSurfaceValue1 );

DLL Function

int CCI_Return = ScSetStringValue(int Value_Type, string STL_File_Path)

int CCI_Return = ScGetStringValue(int Value_Type, ref string STL_File_Path)

ASCII Function

int CCI_Return = ScCciSetStringValue(int Value_Type, string STL_File_Path)

string STL_File_Path = ScCciGetStringValue(int Value_Type)

Description

Set or get the STL file path.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeLoadStl

32

STL_File_Path

Type: string

Unit: none

Specify the Path to STL file.

Alternatively the string "REAPPLY" can be sent to reapply the settings set by STL Projections Properties.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•3D Surfaces type must be set to STL projection.

C# Example: Load a STL file:

int CCI_Return = cci.ScSetStringValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeLoadStl, @"F:\3d_surface.stl" );

C# Example: Get the STL file path:

string STL_File_Path = "";

int CCI_Return = cci.ScGetStringValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeLoadStl, ref STL_File_Path );