Job > Entity Objects

Bitmap Blank Threshold			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Blank_Threshold) int Blank_Threshold = ScGetEntityLongData(string Entity_Name, int Data_ID)
ASCII Function	int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Blank_Threshold) int Blank_Threshold = ScCciGetEntityLongData(string Entity_Name, int Data_ID)
Description	Set or get the state of the bitmap blank threshold flag.
Entity_Name	Type: string	Unit: none
Entity_Name	Specify the entity to be changed.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlLongDataIdBitmapBlankThreshold		122
Blank_Threshold	Type: int	Unit: none
Blank_Threshold	•0: Disable. •1: Enable.
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	•Make sure the flag for mode grayscale, show bitmap and show scanner are set so that the checkbox is to activate.
C# Example: Activate the bitmap blank threshold flag: int CCI_Return = cci.ScSetEntityLongData("bmp1",(int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBitmapBlankThreshold, 1);

Table 159: Bitmap Blank Threshold

Bitmap Line Index Step			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Index_Step) int Index_Step = ScGetEntityLongData(string Entity_Name, int Data_ID)
ASCII Function	int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Index_Step) int Index_Step = ScCciGetEntityLongData(string Entity_Name, int Data_ID)
Description	This feature can be used to reduce local heating of the target material at marking gray scale bitmaps. If ‘Line Index Step' = x > 1 the bitmap will not be marked line by line in one run but in x runs where in each run every xth line will be marked.
Entity_Name	Type: string	Unit: none
Entity_Name	Specify the entity to be changed.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlLongDataIdBitmapLineIndexStep		123
Index_Step	Type: int	Unit: none
Index_Step	For example a Line Index Step of '3' results in this marking order: 1, 4, 7, 10, .., 2, 5, 8, 11, .., 3, 6, 9, 12, ..
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	-
C# Example: Set the line index step of the bitmap "logo" to 3: int CCI_Return = cci.ScSetEntityLongData( "logo", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBitmapLineIndexStep, 3 );
C# Example: Get the line index step of the bitmap "logo": int Index_Step = cci.ScGetEntityLongData( "logo", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBitmapLineIndexStep );

Table 160: Bitmap Blank Threshold

Bitmap Mode			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Flag) int Flag = ScGetEntityLongData(string Entity_Name, int Data_ID)
ASCII Function	int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Flag) int Flag = ScCciGetEntityLongData(string Entity_Name, int Data_ID)
Description	This function is used to manipulate a named bitmap.
Entity_Name	Type: string	Unit: none
Entity_Name	The corresponding entity name.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlLongDataIdBitmapMode		49
Flag	Type: int		Flag:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlLongDataIdBitmapModeInvert		0x1
	scComSAMLightClientCtrlLongDataIdBitmapModeGreyscale		0x2
	scComSAMLightClientCtrlLongDataIdBitmapModeDrillmode		0x4
	scComSAMLightClientCtrlLongDataIdBitmapModeBidirectional		0x8
	scComSAMLightClientCtrlLongDataIdBitmapModeStartlastline		0x10
	scComSAMLightClientCtrlLongDataIdBitmapModeNolineincr		0x20
	scComSAMLightClientCtrlLongDataIdBitmapModeShowBitmap		0x100
	scComSAMLightClientCtrlLongDataIdBitmapModeShowScanner		0x200
	scComSAMLightClientCtrlLongDataIdBitmapModeScanXDir		0x400
	scComSAMLightClientCtrlLongDataIdBitmapModePenFrequency		0x800
	scComSAMLightClientCtrlLongDataIdBitmapModeJumpOverBlankPixels		0x1000
	scComSAMLightClientCtrlLongDataIdBitmapModeDrillGreyscale		0x2000
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	•The scanner bitmap is created after every call to DontUpdateEntity is not set.
C# Example: Set bitmap mode Greyscale and Show Scanner Bitmap: int CCI_Return = cci.ScSetEntityLongData("",(int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBitmapMode,0x202);
C# Example: Get bitmap mode: int Flag = cci.ScGetEntityLongData("", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBitmapMode);

Table 161: Bitmap Mode

Entity Specific Bitmap Settings			☒ Set ☒ Get
DLL Function	int CCI_Return = ScSetEntityDoubleData(string Entity_Name, int Data_ID, double Parameter) int CCI_Return = ScGetEntityDoubleData(string Entity_Name, int Data_ID, ref double Parameter)
ASCII Function	int CCI_Return = ScCciSetEntityDoubleData(string Entity_Name, int Data_ID, double Parameter) double Parameter = ScCciGetEntityDoubleData(string Entity_Name, int Data_ID)
Description	Various entity specific parameters can be changed with the commands below.
Entity_Name	Type: string	Unit: none
Entity_Name	Specify the entity to be changed.
Data_ID	Type: int		ID:
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlDoubleDataIdBitmapIntensity		33
	Changes the intensity of the related bitmap. Range: [0,2]
	scComSAMLightClientCtrlDoubleDataIdBitmapBrightness		34
	Changes the brightness of the related bitmap. Range: [-1,1]
	scComSAMLightClientCtrlDoubleDataIdBitmapDitherstep		35
	Changes the rasterization size of the scanner bitmap. Units: [mm/pixel]
	scComSAMLIghtClientCtrlDoubleDataIdBitmapOneToOne		110
	Map the bitmap pixel 1:1. Parameter: 0
Parameter	Type: int	Unit: none
Parameter	Enter the corresponding parameter.
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	-
C# Example: Set the dither step value to 0.2 for the entity "bmp1": int CCI_Return = cci.ScSetEntityDoubleData("bmp1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdBitmapDitherstep, 0.2);
C# Example: Get the intensity value for the entity "bmp1": double Intensity = 0; int CCI_Return = cci.ScGetEntityDoubleData("bmp1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdBitmapIntensity, ref Intensity);

Table 162: Entity Specific Bitmap Settings

Export Scanner Bitmap			☒ Set ☐ Get
DLL Function	int CCI_Return = ScSetEntityStringData(string Entity_Name, int Data_ID, string Path) int CCI_Return = ScGetEntityStringData(string Entity_Name, int Data_ID, ref string Path)
ASCII Function	int CCI_Return = ScCciSetEntityStringData(string Entity_Name, int Data_ID, string Path) string Path = ScCciGetEntityStringData(string Entity_Name, int Data_ID)
Description	Export a scanner bitmap.
Entity_Name	Type: string	Unit: none
Entity_Name	Specify the entity based on the name.
Data_ID	Type: int
	Location: ScComSAMLightClientCtrlFlags
	scComSAMLightClientCtrlStringDataIdExportScannerBmp		36
Path	Type: string	Unit: none
Path	Specify the path.
CCI_Return	Type: int
CCI_Return	CCI return number, see error list.
Notes	•A scanner bitmap must exists in SAMLight.
C# Example: Export a scanner bitmap: int CCI_Return = cci.ScSetEntityStringData("animal", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdExportScannerBmp, @"C:\animal.bmp");

Table 163: Export Scanner Bitmap

Pixel Map Size			☐ Set ☒ Get
DLL Function	int Pixel_Map_Size = ScGetLongValue(int Value_Type)
ASCII Function	int Pixel_Map_Size = ScCciGetLongValue(int Value_Type)
Description	Return the size of the Pixel Map, means the number of the available Grey value partitions.
Value_Type	Type: int		ID:
	Location: ScComSAMLightClientCtrlValueTypes
	scComSAMLightClientCtrlLongValueTypeSizePixelMap		42
Pixel_Map_Size	Type: int	Unit: none
Pixel_Map_Size	The size of the Pixel Map.
Notes	-
C# Example: Get the size of the pixel map: int Pixel_Map_Size = cci.ScGetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeSizePixelMap);

Table 164: Pixel Map Size