Module omix.api

Package omix.plugin.paint

Interface PaintDeviceInterface

All Superinterfaces:

QPaintDevice, QtObjectInterface

All Known Subinterfaces:

MoviePaintDeviceInterface

public interface PaintDeviceInterface
extends QPaintDevice

This interface must be implemented in order to realize an image export feature for Omix. The interface is derived from QPaintDeviceInterface. An implementing class must be derived from QPaintDevice or other QPaintDeviceInterface deriving Qt classes. Examples:

• public class MyPaintDevice extends QPaintDevice implements PaintDeviceInterface
• public class MyPrinter extends QPrinter implements PaintDeviceInterface
• public class MyPixmap extends QPixmap implements PaintDeviceInterface
• public class MyWidget extends QWidget implements PaintDeviceInterface

A class directly derived from QPaintDevice must deliver a custom subclass of QPaintEngine in QPaintDevice.paintEngine(). This paint engine must draw content into an image of the specific format. If plugin paint routine shall be able to export movies the MoviePaintDeviceInterface must be derived.

Since:

Omix 1.3.11

Author:

Dr. Peter Droste, Omix Visualization

Nested Class Summary

Nested classes/interfaces inherited from interface io.qt.gui.QPaintDevice

QPaintDevice.Impl, QPaintDevice.MemberAccess, QPaintDevice.PaintDeviceMetric

Method Summary

Modifier and Type	Method	Description
void	save()	Called when the image painting process was finished.
void	setCompression(int compression)	Can be used to set the compression value of the image if supported.
void	setGamma(float gamma)	Can be used to set the gamma value of the image if supported.
void	setQuality(int quality)	Can be used to set the quality of the image if supported.
void	setText(String key, String text)	Can be used to write describing information into the image file if supported.

Methods inherited from interface io.qt.gui.QPaintDevice

colorCount, depth, devicePixelRatio, devicePixelRatioF, height, heightMM, logicalDpiX, logicalDpiY, paintEngine, paintingActive, physicalDpiX, physicalDpiY, width, widthMM

Methods inherited from interface io.qt.QtObjectInterface

dispose, isDisposed

Method Details

save

void save() throws PaintException, IOException

Called when the image painting process was finished. This method can manage the file writing process.

Throws:

PaintException

IOException

setText

void setText(String key, String text)

Can be used to write describing information into the image file if supported.

Parameters:

key - type of detail

text - detail text

See Also:

QImageWriter.setText(String, String), PaintHandlerInterface.PaintOption.Description, QImageIOHandler.ImageOption.Description

setGamma

void setGamma(float gamma)

Can be used to set the gamma value of the image if supported.

Parameters:

gamma -

See Also:

QImageWriter.setGamma(float), PaintHandlerInterface.PaintOption.Gamma, QImageIOHandler.ImageOption.Gamma

setQuality

void setQuality(int quality)

Can be used to set the quality of the image if supported.

Parameters:

quality -

See Also:

QImageWriter.setQuality(int), PaintHandlerInterface.PaintOption.Quality, QImageIOHandler.ImageOption.Quality

setCompression

void setCompression(int compression)

Can be used to set the compression value of the image if supported.

Parameters:

compression -

See Also:

QImageWriter.setCompression(int), PaintHandlerInterface.PaintOption.CompressionRatio, QImageIOHandler.ImageOption.CompressionRatio