summaryrefslogtreecommitdiffstats
path: root/src/classes/share/com/sun/j3d/internal/BufferWrapper.java
blob: 8751f6852487f32f60027828482f15928921e998 (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
182
183
184
185
186
187
/*
 * $RCSfile$
 *
 * 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, licensed or
 * intended for use in the design, construction, operation or
 * maintenance of any nuclear facility.
 *
 * $Revision$
 * $Date$
 * $State$
 */

package com.sun.j3d.internal;

import java.nio.Buffer;

import javax.media.j3d.J3DBuffer;

/**
 * NIO Buffers are new in Java 1.4 but we need to run on 1.3
 * as well, so this class was created to hide the NIO classes
 * from non-1.4 Java 3D users.
 *
 * <p>
 * NOTE: We no longer need to support JDK 1.3 as of the Java 3D 1.3.2
 * community source release on java.net. We should be able to get rid
 * of this class.
 */

public abstract class BufferWrapper {

    /**
     * Value returned from getBufferType(), this indicates
     * that the BufferWrapper contains a null buffer.
     */
    public static final int TYPE_NULL = 0;

    /**
     * Value returned from getBufferType(), this indicates
     * that the BufferWrapper does not hold data of type
     * byte, float, or double.
     */
    public static final int TYPE_UNKNOWN = 1;

    /**
     * Value returned from getBufferType(), this indicates
     * that the BufferWrapper contains a java.nio.ByteBuffer.
     */
    public static final int TYPE_BYTE = 2;

    /**
     * Value returned from getBufferType(), this indicates
     * that the BufferWrapper contains a java.nio.FloatBuffer.
     */
    public static final int TYPE_FLOAT = 3;

    /**
     * Value returned from getBufferType(), this indicates
     * that the BufferWrapper contains a java.nio.DoubleBuffer.
     */
    public static final int TYPE_DOUBLE = 4;

    /**
     * Never used - this class is abstract.
     */
    public BufferWrapper() {
    }

    /**
     * Must be implemented by sublasses.
     */
    abstract Buffer getBuffer();

    /**
     * @return Buffer as object of type Object.
     */
    public Object getBufferAsObject() {
	return getBuffer();
    }

    // Wrapper for all relevant Buffer methods.

    /**
     * @return This buffer's capacity (set at initialization in
     * allocateDirect() ).
     * @see ByteBufferWrapper#allocateDirect
     */
    public int capacity() {
	return getBuffer().capacity();
    }

    /**
     * @return This buffer's limit.
     */
    public int limit() {
	return getBuffer().limit();
    }

    /**
     * @return This buffer's position.
     */
    public int position() {
	return getBuffer().position();
    }

    /**
     * Sets this buffer's position.
     * @return This buffer.
     */
    public BufferWrapper position(int newPosition){
	getBuffer().position(newPosition);
	return this;
    }

    /**
     * Resets this buffer's position to the previously marked
     * position.
     * @return This buffer.
     */
    public BufferWrapper rewind() {
	getBuffer().rewind();
	return this;
    }

    /**
     * @return An integer indicating the type of data held in
     * this buffer.
     * @see #TYPE_NULL
     * @see #TYPE_BYTE
     * @see #TYPE_FLOAT
     * @see #TYPE_DOUBLE
     * @see #TYPE_UNKNOWN
     */
    public static int getBufferType(J3DBuffer b) {
	int bufferType;
	Buffer buffer = b.getBuffer();

        if (buffer == null) {
            bufferType = TYPE_NULL;
        }
        else if (buffer instanceof java.nio.ByteBuffer) {
            bufferType = TYPE_BYTE;
        }
        else if (buffer instanceof java.nio.FloatBuffer) {
            bufferType = TYPE_FLOAT;
        }
        else if (buffer instanceof java.nio.DoubleBuffer) {
            bufferType = TYPE_DOUBLE;
        }
        else {
            bufferType = TYPE_UNKNOWN;
        }
	return bufferType;
    }
}