summaryrefslogtreecommitdiffstats
path: root/src/net/java/joglutils/msg/elements/BlendElement.java
blob: 422811fc8b3c4eccb6c9b45373c11c536760fe46 (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
/*
 * 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.elements;

import java.nio.*;
import javax.media.opengl.*;

import net.java.joglutils.msg.math.*;
import net.java.joglutils.msg.misc.*;
import net.java.joglutils.msg.nodes.*;

/** Represents the blending state of the OpenGL fixed-function pipeline. */

public class BlendElement extends Element {
  // Boilerplate
  private static StateIndex index = State.registerElementType();
  public StateIndex getStateIndex() { return index; }
  public Element newInstance() {
    return new BlendElement();
  }
  /** Returns the instance of this element in the passed State. */
  public static BlendElement getInstance(State state) {
    return (BlendElement) state.getElement(index);
  }
  /** Enables this element in the passed state, which should be the
      default for a given action. */
  public static void enable(State defaultState) {
    BlendElement tmp = new BlendElement();
    defaultState.setElement(tmp.getStateIndex(), tmp);
  }
  /** Indicates whether this element is enabled in the given default
      state for a particular action. */
  public static boolean isEnabled(State state) {
    return (state.getDefaults().getElement(index) != null);
  }

  // These defaults match those in the Blend node -- is there a better way of factoring them out?

  // Whether blending is enabled
  protected boolean enabled;
  protected Vec4f blendColor = new Vec4f();
  protected int srcFunc = Blend.ONE;
  protected int destFunc = Blend.ZERO;
  protected int blendEquation = Blend.FUNC_ADD;

  /** Sets all of the portions of the blending state in the passed State object. */
  public static void set(State state,
                         boolean enabled,
                         Vec4f blendColor,
                         int srcFunc,
                         int destFunc,
                         int blendEquation) {
    getInstance(state).setElt(enabled,
                              blendColor,
                              srcFunc,
                              destFunc,
                              blendEquation);
  }

  /** Returns whether blending is enabled. */
  public static boolean getEnabled(State state) {
    return getInstance(state).enabled;
  }

  /** Returns the blending color. */
  public static Vec4f getBlendColor(State state) {
    return getInstance(state).blendColor;
  }

  /** Returns the source function for blending. */
  public static int getSourceFunc(State state) {
    return getInstance(state).srcFunc;
  }

  /** Returns the destination function for blending. */
  public static int getDestFunc(State state) {
    return getInstance(state).destFunc;
  }

  /** Returns the blending equation. */
  public static int getBlendEquation(State state) {
    return getInstance(state).blendEquation;
  }

  public void push(State state) {
    BlendElement prev = (BlendElement) getNextInStack();
    if (prev != null) {
      // Pull down the data from the previous element
      enabled = prev.enabled;
      blendColor.set(prev.blendColor);
      srcFunc = prev.srcFunc;
      destFunc = prev.destFunc;
      blendEquation = prev.blendEquation;
    }
  }

  /** Sets all of the portions of the blending state in this element. */
  public void setElt(boolean enabled,
                     Vec4f blendColor,
                     int srcFunc,
                     int destFunc,
                     int blendEquation) {
    this.enabled = enabled;
    this.blendColor.set(blendColor);
    this.srcFunc = srcFunc;
    this.destFunc = destFunc;
    this.blendEquation = blendEquation;
  }
}