001/*
002 * Copyright 2006 - 2013
003 *     Stefan Balev     <stefan.balev@graphstream-project.org>
004 *     Julien Baudry    <julien.baudry@graphstream-project.org>
005 *     Antoine Dutot    <antoine.dutot@graphstream-project.org>
006 *     Yoann Pigné      <yoann.pigne@graphstream-project.org>
007 *     Guilhelm Savin   <guilhelm.savin@graphstream-project.org>
008 * 
009 * This file is part of GraphStream <http://graphstream-project.org>.
010 * 
011 * GraphStream is a library whose purpose is to handle static or dynamic
012 * graph, create them from scratch, file or any source and display them.
013 * 
014 * This program is free software distributed under the terms of two licenses, the
015 * CeCILL-C license that fits European law, and the GNU Lesser General Public
016 * License. You can  use, modify and/ or redistribute the software under the terms
017 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
018 * URL <http://www.cecill.info> or under the terms of the GNU LGPL as published by
019 * the Free Software Foundation, either version 3 of the License, or (at your
020 * option) any later version.
021 * 
022 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
023 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
024 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
025 * 
026 * You should have received a copy of the GNU Lesser General Public License
027 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
028 * 
029 * The fact that you are presently reading this means that you have had
030 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
031 */
032package org.graphstream.ui.spriteManager;
033
034import org.graphstream.ui.graphicGraph.stylesheet.Values;
035
036/**
037 * Factory for sprites.
038 * 
039 * <p>
040 * Use the sprite factory in the sprite manager so that the manager produce
041 * instance of a chosen subclass of {@link Sprite}. This is useful if you intend
042 * to have each sprite pertain to the same subclass. If you intend to have
043 * different kinds of sprites at the same time in the same manager, use
044 * {@link SpriteManager#addSprite(String, Class)} instead.
045 * </p>
046 */
047public class SpriteFactory {
048        /**
049         * Create a new sprite for the given manager with the given identifier.
050         * 
051         * @param identifier
052         *            Identifier of the newly created sprite.
053         * @param manager
054         *            The sprite manager this sprite will pertain to.
055         * @param position
056         *            The sprite initial position or null for (0,0,0,GU).
057         * @return A new sprite.
058         */
059        public Sprite newSprite(String identifier, SpriteManager manager,
060                        Values position) {
061                if (position != null)
062                        return new Sprite(identifier, manager, position);
063
064                return new Sprite(identifier, manager);
065        }
066}