    001/* ===========================================================
    002 * Orson Charts : a 3D chart library for the Java(tm) platform
    003 * ===========================================================
    004 *
    005 * (C)opyright 2013-2016, by Object Refinery Limited.  All rights reserved.
    006 *
    007 * http://www.object-refinery.com/orsoncharts/index.html
    008 *
    009 * This program is free software: you can redistribute it and/or modify
    010 * it under the terms of the GNU General Public License as published by
    011 * the Free Software Foundation, either version 3 of the License, or
    012 * (at your option) any later version.
    013 *
    014 * This program is distributed in the hope that it will be useful,
    015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
    016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    017 * GNU General Public License for more details.
    018 *
    019 * You should have received a copy of the GNU General Public License
    020 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    021 *
    022 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
    023 * Other names may be trademarks of their respective owners.]
    024 *
    025 * If you do not wish to be bound by the terms of the GPL, an alternative
    026 * commercial license can be purchased.  For details, please see visit the
    027 * Orson Charts home page:
    028 *
    029 * http://www.object-refinery.com/orsoncharts/index.html
    030 *
    031 */
    032
    033package com.orsoncharts.graphics3d;
    034
    035import com.orsoncharts.util.ArgChecks;
    036
    037/**
    038 * A face belonging to an {@link Object3D} that has a tag.
    039 *
    040 * @since 1.3
    041 */
    042public class TaggedFace extends Face {
    043
    044    /** The tag. */
    045    private String tag;
    046
    047    /**
    048     * Creates a new instance.
    049     *
    050     * @param owner  the owner ({@code null} not permitted).
    051     * @param vertices  the vertices (must contain at least 3 vertices).
    052     * @param tag  the tag ({@code null} not permitted).
    053     */
    054    public TaggedFace(Object3D owner, int[] vertices, String tag) {
    055        super(owner, vertices);
    056        ArgChecks.nullNotPermitted(tag, "tag");
    057        this.tag = tag;
    058    }
    059
    060    /**
    061     * Returns the tag that was specified in the constructor.
    062     *
    063     * @return The tag (never {@code null}).
    064     */
    065    @Override
    066    public String getTag() {
    067        return this.tag;
    068    }
    069}