Package: Overlay

Overlay

Coverage

1: /*
2: * *********************************************************************************************************************
3: *
4: * Mistral: open source imaging engine
5: * http://tidalwave.it/projects/mistral
6: *
7: * Copyright (C) 2003 - 2023 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *********************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
12: * the License. You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/mistral-src
23: * git clone https://github.com/tidalwave-it/mistral-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.image.render;
28:
29: import java.awt.Graphics2D;
30:
31: /***********************************************************************************************************************
32: *
33: * An Overlay is something that is drawn over a rendered image.
34: *
35: * @author Fabrizio Giudici
36: *
37: **********************************************************************************************************************/
38: public interface Overlay
39: {
40: /*******************************************************************************************************************
41: *
42: * As the Graphics2D object passed is a copy of the original, this method
43: * can change attributes (e.g. color, clip) without worrying about restoring
44: * them to their original values.
45: *
46: ******************************************************************************************************************/
47: public void paint (Graphics2D g, EditableImageRenderer imageRenderer);
48:
49: /*******************************************************************************************************************
50: *
51: *
52: ******************************************************************************************************************/
53: public boolean isVisible();
54: }