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

library / src / main / java / org / distorted / library / main / DistortedEffects.java @ d4d1958a

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	8e34674e	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
49			// PUBLIC API
50	ada90d33	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
51	d425545a	Leszek Koltunski	/**
52	4e2382f3	Leszek Koltunski	* Create empty effect queue.
53	d425545a	Leszek Koltunski	*/
54	044b5494	Leszek Koltunski	public DistortedEffects()
55	d425545a	Leszek Koltunski	{
56	c7da4e65	leszek	mID = ++mNextID;
57	a0397f32	Leszek Koltunski	mQueues = new EffectQueue[EffectType.LENGTH];
58	20dbec0e	Leszek Koltunski	EffectQueue.allocateQueues(mQueues,null,0);
59	d425545a	Leszek Koltunski	}
60	ada90d33	Leszek Koltunski
61			///////////////////////////////////////////////////////////////////////////////////////////////////
62	d425545a	Leszek Koltunski	/**
63	4e2382f3	Leszek Koltunski	* Copy constructor.
64	d425545a	Leszek Koltunski	* <p>
65			* Whatever we do not clone gets created just like in the default constructor.
66			*
67			* @param dc Source object to create our object from
68			* @param flags A bitmask of values specifying what to copy.
69	e6ab30eb	Leszek Koltunski	* For example, CLONE_VERTEX \| CLONE_MATRIX.
70	d425545a	Leszek Koltunski	*/
71	421c2728	Leszek Koltunski	public DistortedEffects(DistortedEffects dc, int flags)
72	d425545a	Leszek Koltunski	{
73	c7da4e65	leszek	mID = ++mNextID;
74	a0397f32	Leszek Koltunski	mQueues = new EffectQueue[EffectType.LENGTH];
75	20dbec0e	Leszek Koltunski	EffectQueue.allocateQueues(mQueues,dc.getQueues(),flags);
76	d425545a	Leszek Koltunski	}
77	6a06a912	Leszek Koltunski
78			///////////////////////////////////////////////////////////////////////////////////////////////////
79			/**
80	4e2382f3	Leszek Koltunski	* Returns unique ID of this instance.
81			*
82			* @return ID of the object.
83	6a06a912	Leszek Koltunski	*/
84	4e2382f3	Leszek Koltunski	public long getID()
85	d425545a	Leszek Koltunski	{
86	4e2382f3	Leszek Koltunski	return mID;
87	d425545a	Leszek Koltunski	}
88	4e2382f3	Leszek Koltunski
89	6a06a912	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
90			/**
91	d07f2950	Leszek Koltunski	* Aborts all Effects.
92			* @return Number of effects aborted.
93	6a06a912	Leszek Koltunski	*/
94	d425545a	Leszek Koltunski	public int abortAllEffects()
95	13687207	leszek	{
96	a0397f32	Leszek Koltunski	int aborted = 0;
97
98			for( int i=0; i<EffectType.LENGTH; i++)
99			{
100	ceed2df6	Leszek Koltunski	aborted += mQueues[i].removeAll(true);
101	a0397f32	Leszek Koltunski	}
102
103			return aborted;
104	13687207	leszek	}
105	6a06a912	Leszek Koltunski
106			///////////////////////////////////////////////////////////////////////////////////////////////////
107			/**
108	d07f2950	Leszek Koltunski	* Aborts all Effects of a given type, for example all MATRIX Effects.
109	6a06a912	Leszek Koltunski	*
110	da9b3f07	Leszek Koltunski	* @param type one of the constants defined in {@link EffectType}
111	d07f2950	Leszek Koltunski	* @return Number of effects aborted.
112	6a06a912	Leszek Koltunski	*/
113	da9b3f07	Leszek Koltunski	public int abortByType(EffectType type)
114	d425545a	Leszek Koltunski	{
115	a0397f32	Leszek Koltunski	int num = type.ordinal();
116	ceed2df6	Leszek Koltunski	return mQueues[num].removeAll(true);
117	d425545a	Leszek Koltunski	}
118	47316d20	leszek
119			///////////////////////////////////////////////////////////////////////////////////////////////////
120			/**
121	faa3ff56	Leszek Koltunski	* Aborts an Effect by its ID.
122	47316d20	leszek	*
123			* @param id the Id of the Effect to be removed, as returned by getID().
124			* @return Number of effects aborted.
125			*/
126			public int abortById(long id)
127			{
128	a0397f32	Leszek Koltunski	int num = (int)(id&EffectType.MASK);
129			return mQueues[num].removeById(id);
130	47316d20	leszek	}
131
132	6a06a912	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
133			/**
134			* Aborts a single Effect.
135			*
136	6bb59aad	Leszek Koltunski	* @param effect the Effect we want to abort.
137	476bbc81	Leszek Koltunski	* @return number of Effects aborted. Always either 0 or 1.
138	6a06a912	Leszek Koltunski	*/
139	6bb59aad	Leszek Koltunski	public int abortEffect(Effect effect)
140	d425545a	Leszek Koltunski	{
141	a0397f32	Leszek Koltunski	int num = effect.getType().ordinal();
142			return mQueues[num].removeEffect(effect);
143	d425545a	Leszek Koltunski	}
144	6a06a912	Leszek Koltunski
145			///////////////////////////////////////////////////////////////////////////////////////////////////
146			/**
147	e8c81a8e	Leszek Koltunski	* Abort all Effects of a given name, for example all rotations.
148	6a06a912	Leszek Koltunski	*
149	da9b3f07	Leszek Koltunski	* @param name one of the constants defined in {@link EffectName}
150	476bbc81	Leszek Koltunski	* @return number of Effects aborted.
151	6a06a912	Leszek Koltunski	*/
152	da9b3f07	Leszek Koltunski	public int abortByName(EffectName name)
153	d425545a	Leszek Koltunski	{
154	a0397f32	Leszek Koltunski	int num = name.getType().ordinal();
155			return mQueues[num].removeByName(name);
156	d425545a	Leszek Koltunski	}
157	432442f9	Leszek Koltunski
158	6a06a912	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
159			/**
160	34e43b0a	Leszek Koltunski	* Add a new Effect to the tail of our queue.
161	f2fe7e28	Leszek Koltunski	*
162	6bb59aad	Leszek Koltunski	* @param effect The Effect to add.
163	ae77d55e	Leszek Koltunski	* @return <code>true</code> if operation was successful, <code>false</code> otherwise.
164	6a06a912	Leszek Koltunski	*/
165	ae77d55e	Leszek Koltunski	public boolean apply(Effect effect)
166	d425545a	Leszek Koltunski	{
167	a0397f32	Leszek Koltunski	int num = effect.getType().ordinal();
168			return mQueues[num].add(effect);
169	4fde55a0	Leszek Koltunski	}
170	34e43b0a	Leszek Koltunski
171			///////////////////////////////////////////////////////////////////////////////////////////////////
172			/**
173			* Add a new Effect to our queue at a specified position.
174			*
175			* @param effect The Effect to add.
176			* @param position the place in the effects queue where to add the new effect.
177			* @return <code>true</code> if operation was successful, <code>false</code> otherwise.
178			*/
179			public boolean apply(Effect effect, int position)
180			{
181			int num = effect.getType().ordinal();
182			return mQueues[num].add(effect,position);
183			}
184	106ae28d	Leszek Koltunski
185			///////////////////////////////////////////////////////////////////////////////////////////////////
186			/**
187			* Return number of effects of the given type currently in the Queue.
188			*
189			* @param type The EffectType.
190			* @return Number of effects of the given type currently in the Queue.
191			*/
192			public int getNumEffects(EffectType type)
193			{
194			int num = type.ordinal();
195			return mQueues[num].getNumEffects();
196			}
197	f2fe7e28	Leszek Koltunski	}

Project

General

Profile

Distorted Android

library / src / main / java / org / distorted / library / main / DistortedEffects.java @ d4d1958a