1 /*
2  * Copyright (c) 2009-2010 jMonkeyEngine
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  *   notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in the
14  *   documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
17  *   may be used to endorse or promote products derived from this software
18  *   without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 package com.jme3.effect.shapes;
33 
34 import com.jme3.export.Savable;
35 import com.jme3.math.Vector3f;
36 
37 /**
38  * This interface declares methods used by all shapes that represent particle emitters.
39  * @author Kirill
40  */
41 public interface EmitterShape extends Savable, Cloneable {
42 
43     /**
44      * This method fills in the initial position of the particle.
45      * @param store
46      *        store variable for initial position
47      */
getRandomPoint(Vector3f store)48     public void getRandomPoint(Vector3f store);
49 
50     /**
51      * This method fills in the initial position of the particle and its normal vector.
52      * @param store
53      *        store variable for initial position
54      * @param normal
55      *        store variable for initial normal
56      */
getRandomPointAndNormal(Vector3f store, Vector3f normal)57     public void getRandomPointAndNormal(Vector3f store, Vector3f normal);
58 
59     /**
60      * This method creates a deep clone of the current instance of the emitter shape.
61      * @return deep clone of the current instance of the emitter shape
62      */
deepClone()63     public EmitterShape deepClone();
64 }
65