001/*
002 * (C) Copyright 2006-2016 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Tiago Cardoso <[email protected]>
018 */
019package org.nuxeo.ecm.platform.threed;
020
021import java.util.Collection;
022
023/**
024 * Interface for document adapter wrapping a 3D document. Gives access to the transmission formats in the underlying
025 * document.
026 *
027 * @since 8.4
028 */
029public interface ThreeDDocument {
030
031    /**
032     * Returns the main {@link ThreeD} of this {@code ThreeDDocument}.
033     */
034    ThreeD getThreeD();
035
036    /**
037     * Returns all the {@link TransmissionThreeD}s for this {@code ThreeDDocument}.
038     */
039    Collection<TransmissionThreeD> getTransmissionThreeDs();
040
041    /**
042     * Returns a given {@link TransmissionThreeD} based on its {@code name}, {@code null} if this transmission 3d does
043     * not exist.
044     */
045    TransmissionThreeD getTransmissionThreeD(String name);
046
047    /**
048     * Returns all the {@link ThreeDRenderView}s for this {@code ThreeDDocument}.
049     */
050    Collection<ThreeDRenderView> getRenderViews();
051
052    /**
053     * Returns a given {@link ThreeDRenderView} based on its {@code title}, {@code null} if this render view does not
054     * exist.
055     */
056    ThreeDRenderView getRenderView(String title);
057
058}