summaryrefslogtreecommitdiffstats
path: root/src/net/java/joglutils/msg/nodes/Blend.java
blob: af95e00f1a4e2ca793c8947590d63ce1c3ce3e60 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/*
 * Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
 * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 * 
 * You acknowledge that this software is not designed or intended for use
 * in the design, construction, operation or maintenance of any nuclear
 * facility.
 * 
 */

package net.java.joglutils.msg.nodes;

import net.java.joglutils.msg.actions.*;
import net.java.joglutils.msg.elements.*;
import net.java.joglutils.msg.math.*;

/** Provides control over OpenGL blending modes. */

public class Blend extends Node {
  private boolean enabled;
  private Vec4f blendColor = new Vec4f();
  private int srcFunc = ONE;
  private int destFunc = ZERO;
  private int blendEquation = FUNC_ADD;

  static {
    // Enable the elements this node affects for known actions
    GLBlendElement.enable(GLRenderAction.getDefaultState());
  }

  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int ZERO                     = 1;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int ONE                      = 2;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int SRC_COLOR                = 3;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int ONE_MINUS_SRC_COLOR      = 4;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int DST_COLOR                = 5;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int ONE_MINUS_DST_COLOR      = 6;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int SRC_ALPHA                = 7;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int ONE_MINUS_SRC_ALPHA      = 8;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int DST_ALPHA                = 9;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int ONE_MINUS_DST_ALPHA      = 10;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int SRC_ALPHA_SATURATE       = 11;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int CONSTANT_COLOR           = 12;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int ONE_MINUS_CONSTANT_COLOR = 13;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int CONSTANT_ALPHA           = 14;
  /** One of the blend functions. See the OpenGL documentation for glBlendFunc for more details. */
  public static final int ONE_MINUS_CONSTANT_ALPHA = 15;

  /** One of the blend equations. See the OpenGL documentation for glBlendEquation for more details. */
  public static final int FUNC_ADD              = 1;
  /** One of the blend equations. See the OpenGL documentation for glBlendEquation for more details. */
  public static final int FUNC_SUBTRACT         = 2;
  /** One of the blend equations. See the OpenGL documentation for glBlendEquation for more details. */
  public static final int FUNC_REVERSE_SUBTRACT = 3;
  /** One of the blend equations. See the OpenGL documentation for glBlendEquation for more details. */
  public static final int MIN                   = 4;
  /** One of the blend equations. See the OpenGL documentation for glBlendEquation for more details. */
  public static final int MAX                   = 5;

  /** Sets whether blending is enabled. Defaults to false. */
  public void setEnabled(boolean enabled) {
    this.enabled = enabled;
  }

  /** Returns whether blending is enabled. Defaults to false. */
  public boolean getEnabled() {
    return enabled;
  }

  /** Sets the source blending function to one of ZERO, ONE,
      SRC_COLOR, ONE_MINUS_SRC_COLOR, DST_COLOR, ONE_MINUS_DST_COLOR,
      SRC_ALPHA, ONE_MINUS_SRC_ALPHA, DST_ALPHA, ONE_MINUS_DST_ALPHA,
      SRC_ALPHA_SATURATE, CONSTANT_COLOR, ONE_MINUS_CONSTANT_COLOR,
      CONSTANT_ALPHA, or ONE_MINUS_CONSTANT_ALPHA. The default is ONE. */
  public void setSourceFunc(int func) {
    if (func < ZERO || func > ONE_MINUS_CONSTANT_ALPHA) {
      throw new IllegalArgumentException("Illegal source blending function " + func);
    }
    srcFunc = func;
  }

  /** Returns the source blending function. The default is ONE. */
  public int getSourceFunc() {
    return srcFunc;
  }

  /** Sets the destination blending function to one of ZERO, ONE,
      SRC_COLOR, ONE_MINUS_SRC_COLOR, DST_COLOR, ONE_MINUS_DST_COLOR,
      SRC_ALPHA, ONE_MINUS_SRC_ALPHA, DST_ALPHA, ONE_MINUS_DST_ALPHA,
      SRC_ALPHA_SATURATE, CONSTANT_COLOR, ONE_MINUS_CONSTANT_COLOR,
      CONSTANT_ALPHA, or ONE_MINUS_CONSTANT_ALPHA. The default is
      ZERO. */
  public void setDestFunc(int func) {
    if (func < ZERO || func > ONE_MINUS_CONSTANT_ALPHA) {
      throw new IllegalArgumentException("Illegal destination blending function " + func);
    }
    destFunc = func;
  }

  /** Returns the destination blending function. The default is ZERO. */
  public int getDestFunc() {
    return destFunc;
  }

  /** Sets the blending equation to one of FUNC_ADD, FUNC_SUBTRACT,
      FUNC_REVERSE_SUBTRACT, MIN, or MAX. Defaults to FUNC_ADD. */
  public void setBlendEquation(int equation) {
    if (equation < FUNC_ADD || equation > MAX) {
      throw new IllegalArgumentException("Illegal blending equation " + equation);
    }
    this.blendEquation = equation;
  }

  /** Returns the blending equation. Defaults to FUNC_ADD. */
  public int getBlendEquation() {
    return blendEquation;
  }

  /** Sets the blending color; see the documentation for glBlendColor
      for more details. Defaults to [0, 0, 0, 0]. */
  public void setBlendColor(Vec4f color) {
    blendColor.set(color);
  }

  /** Gets the blending color; see the documentation for glBlendColor
      for more details. Defaults to [0, 0, 0, 0]. */
  public Vec4f getBlendColor() {
    return blendColor;
  }

  public void doAction(Action action) {
    if (BlendElement.isEnabled(action.getState())) {
      BlendElement.set(action.getState(),
                       getEnabled(),
                       getBlendColor(),
                       getSourceFunc(),
                       getDestFunc(),
                       getBlendEquation());
    }
  }
}