/src/main/java/org/distorted/library/main/DistortedEffects.java - Annotate - Distorted Android

library / src / main / java / org / distorted / library / main / DistortedEffects.java @ 246d021c

1	d333eb6b	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
2			// Copyright 2016 Leszek Koltunski //
3			// //
4	46b572b5	Leszek Koltunski	// This file is part of Distorted. //
5	d333eb6b	Leszek Koltunski	// //
6	46b572b5	Leszek Koltunski	// Distorted is free software: you can redistribute it and/or modify //
7	d333eb6b	Leszek Koltunski	// it under the terms of the GNU General Public License as published by //
8			// the Free Software Foundation, either version 2 of the License, or //
9			// (at your option) any later version. //
10			// //
11	46b572b5	Leszek Koltunski	// Distorted is distributed in the hope that it will be useful, //
12	d333eb6b	Leszek Koltunski	// but WITHOUT ANY WARRANTY; without even the implied warranty of //
13			// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
14			// GNU General Public License for more details. //
15			// //
16			// You should have received a copy of the GNU General Public License //
17	46b572b5	Leszek Koltunski	// along with Distorted. If not, see <http://www.gnu.org/licenses/>. //
18	d333eb6b	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
19
20	fe82a979	Leszek Koltunski	package org.distorted.library.main;
21	6a06a912	Leszek Koltunski
22	fe82a979	Leszek Koltunski	import org.distorted.library.effect.Effect;
23	da9b3f07	Leszek Koltunski	import org.distorted.library.effect.EffectName;
24	809dcae3	Leszek Koltunski	import org.distorted.library.effectqueue.EffectQueue;
25	da9b3f07	Leszek Koltunski	import org.distorted.library.effect.EffectType;
26	c638c1b0	Leszek Koltunski
27	6a06a912	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
28	b329f352	Leszek Koltunski	/**
29	faa3ff56	Leszek Koltunski	* Class containing Matrix, Vertex, Fragment and Postprocessing effect queues.
30	b73dcaa7	Leszek Koltunski	* <p>
31	715e7726	Leszek Koltunski	* The queues hold actual effects to be applied to a given (InputSurface,MeshBase) combo.
32	b329f352	Leszek Koltunski	*/
33	86d322b5	Leszek Koltunski	public class DistortedEffects
34	d425545a	Leszek Koltunski	{
35	8e34674e	Leszek Koltunski	private static long mNextID =0;
36	4e2382f3	Leszek Koltunski	private long mID;
37	a0397f32	Leszek Koltunski	private EffectQueue[] mQueues;
38	3d590d8d	Leszek Koltunski
39	55c14a19	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
40	809dcae3	Leszek Koltunski	/**
41			* @y.exclude
42			*/
43			public EffectQueue[] getQueues()
44	d425545a	Leszek Koltunski	{
45	a0397f32	Leszek Koltunski	return mQueues;
46	80b3acf6	Leszek Koltunski	}
47
48	78e89fb5	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
49
50			static void onDestroy()
51			{
52			mNextID = 0;
53			}
54
55	8e34674e	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
56			// PUBLIC API
57	ada90d33	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
58	d425545a	Leszek Koltunski	/**
59	4e2382f3	Leszek Koltunski	* Create empty effect queue.
60	d425545a	Leszek Koltunski	*/
61	044b5494	Leszek Koltunski	public DistortedEffects()
62	d425545a	Leszek Koltunski	{
63	c7da4e65	leszek	mID = ++mNextID;
64	a0397f32	Leszek Koltunski	mQueues = new EffectQueue[EffectType.LENGTH];
65	20dbec0e	Leszek Koltunski	EffectQueue.allocateQueues(mQueues,null,0);
66	d425545a	Leszek Koltunski	}
67	ada90d33	Leszek Koltunski
68			///////////////////////////////////////////////////////////////////////////////////////////////////
69	d425545a	Leszek Koltunski	/**
70	4e2382f3	Leszek Koltunski	* Copy constructor.
71	d425545a	Leszek Koltunski	* <p>
72			* Whatever we do not clone gets created just like in the default constructor.
73			*
74			* @param dc Source object to create our object from
75			* @param flags A bitmask of values specifying what to copy.
76	e6ab30eb	Leszek Koltunski	* For example, CLONE_VERTEX \| CLONE_MATRIX.
77	d425545a	Leszek Koltunski	*/
78	421c2728	Leszek Koltunski	public DistortedEffects(DistortedEffects dc, int flags)
79	d425545a	Leszek Koltunski	{
80	c7da4e65	leszek	mID = ++mNextID;
81	a0397f32	Leszek Koltunski	mQueues = new EffectQueue[EffectType.LENGTH];
82	20dbec0e	Leszek Koltunski	EffectQueue.allocateQueues(mQueues,dc.getQueues(),flags);
83	d425545a	Leszek Koltunski	}
84	6a06a912	Leszek Koltunski
85			///////////////////////////////////////////////////////////////////////////////////////////////////
86			/**
87	4e2382f3	Leszek Koltunski	* Returns unique ID of this instance.
88			*
89			* @return ID of the object.
90	6a06a912	Leszek Koltunski	*/
91	4e2382f3	Leszek Koltunski	public long getID()
92	d425545a	Leszek Koltunski	{
93	4e2382f3	Leszek Koltunski	return mID;
94	d425545a	Leszek Koltunski	}
95	4e2382f3	Leszek Koltunski
96	6a06a912	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
97			/**
98	d07f2950	Leszek Koltunski	* Aborts all Effects.
99			* @return Number of effects aborted.
100	6a06a912	Leszek Koltunski	*/
101	d425545a	Leszek Koltunski	public int abortAllEffects()
102	13687207	leszek	{
103	a0397f32	Leszek Koltunski	int aborted = 0;
104
105			for( int i=0; i<EffectType.LENGTH; i++)
106			{
107	ceed2df6	Leszek Koltunski	aborted += mQueues[i].removeAll(true);
108	a0397f32	Leszek Koltunski	}
109
110			return aborted;
111	13687207	leszek	}
112	6a06a912	Leszek Koltunski
113			///////////////////////////////////////////////////////////////////////////////////////////////////
114			/**
115	d07f2950	Leszek Koltunski	* Aborts all Effects of a given type, for example all MATRIX Effects.
116	6a06a912	Leszek Koltunski	*
117	da9b3f07	Leszek Koltunski	* @param type one of the constants defined in {@link EffectType}
118	d07f2950	Leszek Koltunski	* @return Number of effects aborted.
119	6a06a912	Leszek Koltunski	*/
120	da9b3f07	Leszek Koltunski	public int abortByType(EffectType type)
121	d425545a	Leszek Koltunski	{
122	a0397f32	Leszek Koltunski	int num = type.ordinal();
123	ceed2df6	Leszek Koltunski	return mQueues[num].removeAll(true);
124	d425545a	Leszek Koltunski	}
125	47316d20	leszek
126			///////////////////////////////////////////////////////////////////////////////////////////////////
127			/**
128	faa3ff56	Leszek Koltunski	* Aborts an Effect by its ID.
129	47316d20	leszek	*
130			* @param id the Id of the Effect to be removed, as returned by getID().
131			* @return Number of effects aborted.
132			*/
133			public int abortById(long id)
134			{
135	a0397f32	Leszek Koltunski	int num = (int)(id&EffectType.MASK);
136			return mQueues[num].removeById(id);
137	47316d20	leszek	}
138
139	6a06a912	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
140			/**
141			* Aborts a single Effect.
142			*
143	6bb59aad	Leszek Koltunski	* @param effect the Effect we want to abort.
144	476bbc81	Leszek Koltunski	* @return number of Effects aborted. Always either 0 or 1.
145	6a06a912	Leszek Koltunski	*/
146	6bb59aad	Leszek Koltunski	public int abortEffect(Effect effect)
147	d425545a	Leszek Koltunski	{
148	a0397f32	Leszek Koltunski	int num = effect.getType().ordinal();
149			return mQueues[num].removeEffect(effect);
150	d425545a	Leszek Koltunski	}
151	6a06a912	Leszek Koltunski
152			///////////////////////////////////////////////////////////////////////////////////////////////////
153			/**
154	e8c81a8e	Leszek Koltunski	* Abort all Effects of a given name, for example all rotations.
155	6a06a912	Leszek Koltunski	*
156	da9b3f07	Leszek Koltunski	* @param name one of the constants defined in {@link EffectName}
157	476bbc81	Leszek Koltunski	* @return number of Effects aborted.
158	6a06a912	Leszek Koltunski	*/
159	da9b3f07	Leszek Koltunski	public int abortByName(EffectName name)
160	d425545a	Leszek Koltunski	{
161	a0397f32	Leszek Koltunski	int num = name.getType().ordinal();
162			return mQueues[num].removeByName(name);
163	d425545a	Leszek Koltunski	}
164	432442f9	Leszek Koltunski
165	6a06a912	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
166			/**
167	34e43b0a	Leszek Koltunski	* Add a new Effect to the tail of our queue.
168	f2fe7e28	Leszek Koltunski	*
169	6bb59aad	Leszek Koltunski	* @param effect The Effect to add.
170	ae77d55e	Leszek Koltunski	* @return <code>true</code> if operation was successful, <code>false</code> otherwise.
171	6a06a912	Leszek Koltunski	*/
172	ae77d55e	Leszek Koltunski	public boolean apply(Effect effect)
173	d425545a	Leszek Koltunski	{
174	a0397f32	Leszek Koltunski	int num = effect.getType().ordinal();
175			return mQueues[num].add(effect);
176	4fde55a0	Leszek Koltunski	}
177	34e43b0a	Leszek Koltunski
178			///////////////////////////////////////////////////////////////////////////////////////////////////
179			/**
180			* Add a new Effect to our queue at a specified position.
181			*
182			* @param effect The Effect to add.
183			* @param position the place in the effects queue where to add the new effect.
184			* @return <code>true</code> if operation was successful, <code>false</code> otherwise.
185			*/
186			public boolean apply(Effect effect, int position)
187			{
188			int num = effect.getType().ordinal();
189			return mQueues[num].add(effect,position);
190			}
191	106ae28d	Leszek Koltunski
192			///////////////////////////////////////////////////////////////////////////////////////////////////
193			/**
194			* Return number of effects of the given type currently in the Queue.
195			*
196			* @param type The EffectType.
197			* @return Number of effects of the given type currently in the Queue.
198			*/
199			public int getNumEffects(EffectType type)
200			{
201			int num = type.ordinal();
202			return mQueues[num].getNumEffects();
203			}
204	f2fe7e28	Leszek Koltunski	}

Project

General

Profile

Distorted Android

library / src / main / java / org / distorted / library / main / DistortedEffects.java @ 246d021c