MBS Plugin Documentation

Search:

Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchie

New in Version 7.0 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 8.0 8.1 8.2 8.3 8.4 8.5 8.6 8.7 9.0

The list of the   themes,   classes,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

TiffPictureMBS.AddCustomTag(Tag as integer, FieldReadCount as integer, FieldWriteCount as integer, FieldType as integer, FieldBit as integer, OkToChange as integer, PassCount as integer, FieldName as string) as boolean
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 8.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Adds a custom tag.
Example:
const TIFFTAG_ASCIITAG = 40666
const TIFFTAG_LONGTAG = 40667
const TIFFTAG_SHORTTAG = 40668
const TIFFTAG_RATIONALTAG = 40669
const TIFFTAG_FLOATTAG = 40670
const TIFFTAG_DOUBLETAG = 40671
const TIFFTAG_BYTE = 40672

const TIFFTAG_SOFTWARE=305

const TIFF_BYTE=1
const TIFF_ASCII=2
const TIFF_SHORT=3 // integer 16 bit signed
const TIFF_LONG=4 // integer 32 bit
const TIFF_FLOAT=11
const TIFF_DOUBLE=12

const FIELD_CUSTOM = 65

dim t as new TiffPictureMBS

// open tiff

if not t.AddCustomTag(TIFFTAG_ASCIITAG, -1, -1, TIFF_ASCII, FIELD_CUSTOM, 1, 0, "MyString") then
MsgBox "AddCustomTag failed1."
end if


Notes: See tiff documentation for details.
TiffPictureMBS.AddImage as boolean
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 5.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Writes existing picture and header information to file and starts a new one.
Example:
dim t as TiffPictureMBS
dim f as FolderItem
dim p as Picture

f=DesktopFolder.Child("test.tif")
t=new TiffPictureMBS
if t.Create(f) then

p=NewPicture(100,100,32)
p.Graphics.ForeColor=rgb(255,0,0)
p.Graphics.FillOval 0,0,100,100
t.Pict=p
if t.WriteRGB then
if t.AddImage then
p=NewPicture(100,100,32)
p.Graphics.ForeColor=rgb(0,0,255)
p.Graphics.FillOval 0,0,100,100
t.Pict=p
if t.WriteRGB then
MsgBox "Written multi picture tiff."
end if
end if
end if
end if

Notes:
Returns true on success and false on any error.

Calls TIFFWriteDirectory internally.
TiffPictureMBS.BitsPerSample as integer
property, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The count of bits for each pixel component.
Notes:
Should normally by 8 for RGB images.
(Read and Write property)
TiffPictureMBS.BytesPerRow as Integer
property, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The number of bytes needed for each row in a scan line.
Notes:
0 on any error.
(Read only property)
class TiffPictureMBS
class, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Mac OS X: Works, Windows: Does nothing, Linux x86: Works, Feedback.

Function: A class for a Tiff picture.
Notes: With version 3.1 of the MBS Plugin this plugin part moved to the Pro plugin.
TiffPictureMBS.close
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 3.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Closes the Tiff handle.
Notes:
In 5.1 and older the destructor.
In 5.2 and later only closes the tiff handle so you can still read the pictures, the output or input buffer.
TiffPictureMBS.CombineBitCMYKtoCMYK(CyanChannel() as integer, MagentaChannel() as integer, YellowChannel() as integer, BlackChannel() as integer, Files() as FolderItem, scale as double, width as integer, height as integer, X1 as integer, Y1 as integer, X2 as integer, Y2 as integer, CacheSizeRead as integer) as integer
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 6.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Combines 1bit raw image files to one CMYK tiff.
Notes:
All arrays have the same size specifying for each 1bit grayscal esource image the colors to be used in the final image.
Result image is written to the output picture which is created. Error code is returned which is 0 for no error.
CacheSize can be set to a value greater than 0. And it may make the process faster or slower depending on what you do.
TiffPictureMBS.CombinePictureWithMask as picture
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns a new picture which is created using the picture and it's mask.
Example:
dim t as TiffPictureMBS
' ...
canvas1.backdrop=t.CombinePictureWithMask

TiffPictureMBS.CombineTiff1BitCMYKtoTiff(CyanChannel() as integer, MagentaChannel() as integer, YellowChannel() as integer, BlackChannel() as integer, TiffData() as TiffPictureMBS, scale as double, width as integer, height as integer, X1 as integer, Y1 as integer, X2 as integer, Y2 as integer) as integer
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 6.3, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Combines 1bit tiff image files to one CMYK tiff.
Notes:
All arrays have the same size specifying for each 1bit grayscal esource image the colors to be used in the final image.
Result image is written to the output picture which is created. Error code is returned which is 0 for no error.
Compression can be set before data is written to current tiff which is for output. The tiff object for output must be perfectly setup before using this function.
TiffPictureMBS.CombineTiffCMYKtoCMYK(CyanChannel() as integer, MagentaChannel() as integer, YellowChannel() as integer, BlackChannel() as integer, TiffData() as TiffPictureMBS) as integer
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 6.0, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Combines Grayscale tiff images to one CMYK tiff.
Example:
const PLANARCONFIG_CONTIG=1
const PHOTOMETRIC_RGB=2
const FILLORDER_MSB2LSB=1
const PHOTOMETRIC_SEPARATED=5

dim u,v,ot,t(4) as TiffPictureMBS
dim f as FolderItem
dim pnach as Picture
dim dC(4), dM(4), dY(4), dK(4) As Double
dim nC(4), nM(4), nY(4), nK(4) as integer
dim i as integer

//Cyan
dK(0)=0.0
dC(0)=1.0
dM(0)=0.0
dY(0)=0.0
//Magenta
dK(1)=0.00
dC(1)=0.0
dM(1)=1.0
dY(1)=0.0
//Yellow
dK(2)=0.00
dC(2)=0.0
dM(2)=0.0
dY(2)=1.0
//Black
dK(3)=1.00
dC(3)=0.0
dM(3)=0.0
dY(3)=0.0
//Pantone, S0
dK(4)=0.00
dC(4)=0.60
dM(4)=0.35
dY(4)=0.15

//Bilder
f=GetFolderItem("test.Cyan.tif")
t(0)=f.OpenAsTiffMBS

f=GetFolderItem("test.Magenta.tif")
t(1)=f.OpenAsTiffMBS

f=GetFolderItem("test.Yellow.tif")
t(2)=f.OpenAsTiffMBS

f=GetFolderItem("test.Black.tif")
t(3)=f.OpenAsTiffMBS

f=GetFolderItem("test.S0.tif")
t(4)=f.OpenAsTiffMBS

for i=0 to 4
nC(i)=dC(i)*1000.0
nM(i)=dM(i)*1000.0
nY(i)=dY(i)*1000.0
nK(i)=dK(i)*1000.0
next

f=GetFolderItem("resultCMYK.tif")
ot=new TiffPictureMBS
if ot.Create(f) then
v=t(0)
u=ot
u.Width=v.Width
u.Height=v.Height
u.RowsPerStrip=v.Height
u.BitsPerSample=8
u.SamplesPerPixel=4
u.ResolutionUnit=v.ResolutionUnit
u.HorizontalPosition=v.HorizontalPosition
u.HorizontalResolution=v.HorizontalResolution
u.VerticalPosition=v.VerticalPosition
u.VerticalResolution=v.VerticalResolution
u.Orientation=v.Orientation
u.PlanarConfig=PLANARCONFIG_CONTIG
u.Photometric=PHOTOMETRIC_SEPARATED
u.FillOrder=FILLORDER_MSB2LSB
Title=str(ot.CombineTiffCMYKtoCMYK(nC,nM,nY,nK,t))
ot.Close
end if

//Neues Bild anzeigen
pnach=f.OpenAsPicture
if pnach<>Nil then
Window1.Width=pNach.Width
Window1.Height=pNach.Height
Window1.Backdrop=pNach
end if

Notes:
All arrays have the same size specifying for each 8bit grayscal esource image the colors to be used in the final image.
Result image is written to the current tiffpicture. Error code is returned which is 0 for no error.
You need to set yourself all needed tiffpicture parameters for the output image and you must create it before.
TiffPictureMBS.CombineTiffCMYKtoRGB(CyanChannel() as integer, MagentaChannel() as integer, YellowChannel() as integer, BlackChannel() as integer, TiffData() as TiffPictureMBS) as integer
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 6.0, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Combines Grayscale tiff images to one RGB tiff.
Example:
const PLANARCONFIG_CONTIG=1
const PHOTOMETRIC_RGB=2
const FILLORDER_MSB2LSB=1

dim u,v,ot,t(4) as TiffPictureMBS
dim f as FolderItem
dim pnach as Picture
dim dC(4), dM(4), dY(4), dK(4) As Double
dim nC(4), nM(4), nY(4), nK(4) as integer
dim i as integer

//Cyan
dK(0)=0.0
dC(0)=1.0
dM(0)=0.0
dY(0)=0.0
//Magenta
dK(1)=0.00
dC(1)=0.0
dM(1)=1.0
dY(1)=0.0
//Yellow
dK(2)=0.00
dC(2)=0.0
dM(2)=0.0
dY(2)=1.0
//Black
dK(3)=1.00
dC(3)=0.0
dM(3)=0.0
dY(3)=0.0
//Pantone, S0
dK(4)=0.00
dC(4)=0.60
dM(4)=0.35
dY(4)=0.15

//Bilder
f=GetFolderItem("test.Cyan.tif")
t(0)=f.OpenAsTiffMBS

f=GetFolderItem("test.Magenta.tif")
t(1)=f.OpenAsTiffMBS

f=GetFolderItem("test.Yellow.tif")
t(2)=f.OpenAsTiffMBS

f=GetFolderItem("test.Black.tif")
t(3)=f.OpenAsTiffMBS

f=GetFolderItem("test.S0.tif")
t(4)=f.OpenAsTiffMBS

for i=0 to 4
nC(i)=dC(i)*1000.0
nM(i)=dM(i)*1000.0
nY(i)=dY(i)*1000.0
nK(i)=dK(i)*1000.0
next

f=GetFolderItem("resultRGB.tif")
ot=new TiffPictureMBS
if ot.Create(f) then
v=t(0)
u=ot
u.Width=v.Width
u.Height=v.Height
u.RowsPerStrip=v.Height
u.BitsPerSample=8
u.SamplesPerPixel=3
u.ResolutionUnit=v.ResolutionUnit
u.HorizontalPosition=v.HorizontalPosition
u.HorizontalResolution=v.HorizontalResolution
u.VerticalPosition=v.VerticalPosition
u.VerticalResolution=v.VerticalResolution
u.Orientation=v.Orientation
u.PlanarConfig=PLANARCONFIG_CONTIG
u.Photometric=PHOTOMETRIC_RGB
u.FillOrder=FILLORDER_MSB2LSB
Title=str(ot.CombineTiffCMYKtoRGB(nC,nM,nY,nK,t))
ot.Close
end if

//Neues Bild anzeigen
pnach=f.OpenAsPicture
if pnach<>Nil then
Window1.Width=pNach.Width
Window1.Height=pNach.Height
Window1.Backdrop=pNach
end if

Notes:
All arrays have the same size specifying for each 8bit grayscal esource image the colors to be used in the final image.
Result image is written to the current tiffpicture. Error code is returned which is 0 for no error.
You need to set yourself all needed tiffpicture parameters for the output image and you must create it before.
TiffPictureMBS.Compression as Integer
property, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The compression used.
Notes:
some constants:
COMPRESSION_NONE1dump mode
COMPRESSION_CCITTRLE2CCITT modified Huffman RLE
COMPRESSION_CCITTFAX33CCITT Group 3 fax encoding
COMPRESSION_CCITT_T43CCITT T.4 (TIFF 6 name)
COMPRESSION_CCITTFAX44CCITT Group 4 fax encoding
COMPRESSION_CCITT_T64CCITT T.6 (TIFF 6 name)
COMPRESSION_LZW5Lempel-Ziv & Welch
COMPRESSION_OJPEG6!6.0 JPEG
COMPRESSION_JPEG7%JPEG DCT compression
COMPRESSION_NEXT32766NeXT 2-bit RLE
COMPRESSION_CCITTRLEW32771#1 w/ word alignment
COMPRESSION_PACKBITS32773Macintosh RLE
COMPRESSION_THUNDERSCAN32809ThunderScan RLE
COMPRESSION_IT8CTPAD32895IT8 CT w/padding
COMPRESSION_IT8LW32896IT8 Linework RLE
COMPRESSION_IT8MP32897IT8 Monochrome picture
COMPRESSION_IT8BL32898IT8 Binary line art
COMPRESSION_PIXARFILM32908Pixar companded 10bit LZW
COMPRESSION_PIXARLOG32909Pixar companded 11bit ZIP
COMPRESSION_DEFLATE32946Deflate compression
COMPRESSION_ADOBE_DEFLATE8Deflate compression, as recognized by Adobe
COMPRESSION_DCS32947Kodak DCS encoding
COMPRESSION_JBIG34661ISO JBIG
COMPRESSION_SGILOG34676SGI Log Luminance RLE
COMPRESSION_SGILOG2434677SGI Log 24-bit packed

The data for this property is stored in the Tiff file.
(Read and Write property)
TiffPictureMBS.Copyright as String
property, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The copyright notice of this image.
Notes:
The data for this property is stored in the Tiff file.
(Read and Write property)
TiffPictureMBS.Create(file as folderitem) as boolean
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Creates a new empty tiff file.
Example:
dim p as Picture
dim f as FolderItem
dim t as TiffPictureMBS

p=NewPicture(100,100,32)

f=DesktopFolder.Child("test.tif")

t=new TiffPictureMBS
t.Pict=p

if t.Create(f) then
if t.WriteRGB then
t.Close
MsgBox "Ok"
f.Launch
end if
end if

Notes:
Returns true on success.

This function uses pathes like all Tiff functions, so be sure there are not two volumes named equal on a Mac OS Classic system.
TiffPictureMBS.Create(file as folderitem, endian as integer) as boolean
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Creates a new empty tiff file.
Notes:
Returns true on success.

Endian settings:
0Default (System)
1BigEndian (Mac)
2LittleEndian (Win)

This function uses pathes like all Tiff functions, so be sure there are not two volumes named equal on a Mac OS Classic system.
TiffPictureMBS.CreateString(Size as integer) as boolean
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Creates a new string based tiff writer.
Example:
Function PictureToTiffStringMBS(pic as picture) As string
dim t as MyTiffPictureMBS

t=new MyTiffPictureMBS
if t.CreateString(&h100000) then
t.Pict=pic
if t.WriteRGB then
t.Close
Return t.OutputBuffer
end if
end if
End Function

Notes:
Same as the Create() function, but memory based. You can now use functions like Scanline(), WriteSW() or WriteRGB() to put the picture data.

Returns true on success.
The Warning and Error events may show you reasons why it does not work.

The size parameter you pass in is a guess for the initial size of the memory block used. If more data is written, the memory block is resized, but it is quite slow to resize a memoryblock, so make a good guess!

You can and should use this function to write yourself a PictureToTiffString function. The plugin can not well make such a function as there are thousands of possible parameters combination you may want to use. (compared to the JPEG library where you only have the compression level parameter.)
TiffPictureMBS.CreateString(Size as integer, Mode as string) as boolean
method, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 5.3, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Creates a new string based tiff writer.
Notes:
Same as the other CreateString method, but you can pass a mode string to the library.

mode="wb" for big endian and mode="wl" for little endian.
TiffPictureMBS.DateTime as String
property, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Date and time of the TIFF file.
Notes:
Check some TIFF files for the format used.

The data for this property is stored in the Tiff file.
(Read and Write property)
TiffPictureMBS.DocumentName as String
property, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The name of the document.
Notes:
The data for this property is stored in the Tiff file.
(Read and Write property)
TiffPictureMBS.Error(libModule as string, message as string)
event, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: An event called whenever an error is to be reported.
TiffPictureMBS.ExtraSamples as MemoryBlock
property, Pictures Import and Export, MBS Tiff Plugin (Tiff), class TiffPictureMBS, Plugin version: 4.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The settings for the extra samples.
Notes:
A memoryblock filled with an array of shorts (16bit integers).

constants:
EXTRASAMPLE_UNSPECIFIED0unspecified data
EXTRASAMPLE_ASSOCALPHA1associated alpha data (pre multiplied)
EXTRASAMPLE_UNASSALPHA2unassociated alpha data (mask in RB)

The data for this property is stored in the Tiff file.
(Read and Write property)

Previous items Next items

The items on this page are in the following plugins: MBS Tiff Plugin.