Container.hpp

Go to the documentation of this file.

/*
 * Author: Sven Gothel <sgothel@jausoft.com> (C++, Java) and Rami Santina (Java)
 * Copyright Gothel Software e.K. and the authors
 *
 * SPDX-License-Identifier: MIT
 *
 * This Source Code Form is subject to the terms of the MIT License
 * If a copy of the MIT was not distributed with this file,
 * you can obtain one at https://opensource.org/license/mit/.
 */
#ifndef JAU_GAMP_GRAPH_UI_CONTAINER_HPP_
#define JAU_GAMP_GRAPH_UI_CONTAINER_HPP_
 
#include <jau/basic_types.hpp>
#include <jau/darray.hpp>
#include <jau/float_math.hpp>
#include <jau/float_types.hpp>
#include <jau/fraction_type.hpp>
#include <jau/math/geom/aabbox3f.hpp>
#include <jau/math/geom/geom3f.hpp>
#include <jau/math/vec3f.hpp>
#include <jau/math/vec4f.hpp>
#include <jau/math/vec4f.hpp>
#include <jau/math/quaternion.hpp>
 
#include <gamp/Gamp.hpp>
#include <gamp/graph/OutlineShape.hpp>
#include <gamp/render/RenderContext.hpp>
 
namespace gamp::graph::ui {
 
    using namespace jau::math;
    using namespace jau::math::util;
    using namespace jau::math::geom;
    
    using namespace gamp::wt;
    using namespace gamp::wt::event;
    using namespace gamp::render;
    
    using namespace gamp::graph;
    
    /** \addtogroup Gamp_GraphUI
     *
     *  @{
     */
 
    class Shape;
    typedef std::shared_ptr<Shape> ShapeRef;
    typedef std::vector<ShapeRef> ShapeList;
    
    class RegionRenderer;
    
    /**
     * Container interface of UI {@link Shape}s
     * @see Scene
     * @see Shape
     */
    class Container {
      public:    
        /** Returns number of {@link Shape}s, see {@link #getShapes()}. */
        virtual size_t shapeCount() const noexcept = 0;
    
        /** Returns {@link #addShape(Shape) added} {@link Shape}s. */
        virtual const ShapeList& shapes() const noexcept = 0;
    
        /**
         * Returns {@link #addShape(Shape) added shapes} which are rendered and sorted by z-axis in ascending order toward z-near.
         * <p>
         * The rendered shapes are {@link Shape#isVisible() visible} and not deemed outside of this container due to {@link #isCullingEnabled() culling}.
         * </p>
         * <p>
         * Only rendered shapes are considered for picking/activation.
         * </p>
         * <p>
         * The returned list is data-race free, i.e. won't be mutated by the rendering thread
         * as it gets completely replace at each rendering loop using a local volatile reference.<br/>
         * Only when disposing the container, the list gets cleared, hence {@Link List#size()} shall be used in the loop.
         * </p>
         * @see #addShape(Shape)
         * @see #isCullingEnabled()
         * @see Shape#isVisible()
         * @see #isOutside(PMVMatrix4f, Shape)
         */
        virtual ShapeList& renderedShapes() const noexcept = 0;
    
        /** Adds a {@link Shape}. */
        virtual void addShape(const ShapeRef& s) const noexcept = 0;
    
        /**
         * Removes given shape, w/o {@link Shape#destroy(GL2ES2, RegionRenderer)}.
         * @return the removed shape or null if not contained
         */
        virtual ShapeRef removeShape(const ShapeRef& s) const noexcept = 0;
    
        /** Removes all given shapes, w/o {@link Shape#destroy(GL2ES2, RegionRenderer)}. */
        virtual void removeShapes(const ShapeList& shapes) = 0;
    
        /**
         * Removes given shape with {@link Shape#destroy(GL2ES2, RegionRenderer)}, if contained.
         * @param gl GL2ES2 context
         * @param renderer
         * @param s the shape to be removed
         * @return true if given Shape is removed and destroyed
         */
        // virtual bool removeShape(RenderContext& rc, final RegionRenderer renderer, const ShapeRef& s) = 0;
    
        virtual void addShapes(const ShapeList& shapes) = 0;
    
        /** Removes all given shapes with {@link Shape#destroy(GL2ES2, RegionRenderer)}. */
        virtual void removeShapes(RenderContext& rc, RegionRenderer& renderer, const ShapeList& shapes) = 0;
    
        /** Removes all contained shapes with {@link Shape#destroy(GL2ES2, RegionRenderer)}. */
        virtual void removeAllShapes(RenderContext& rc, RegionRenderer& renderer) = 0;
    
        virtual bool contains(const Shape& s) = 0;
    
        virtual Shape& getShapeByIdx(int id) const noexcept = 0;
        virtual Shape& getShapeByID(int id) const noexcept = 0;
        virtual Shape& getShapeByName(const std::string& name) const noexcept = 0;
    
        /** Returns {@link AABBox} dimension of given {@link Shape} from this container's perspective, i.e. world-bounds if performing from the {@link Scene}. */
        virtual const AABBox3f& bounds(const PMVMat4f& pmv, const Shape& shape) const noexcept = 0;
    
        /** Enable or disable {@link PMVMatrix4f#getFrustum() Project-Modelview (PMv) frustum} culling per {@link Shape} for this container. Default is disabled. */
        virtual void setPMvCullingEnabled(bool v) noexcept = 0;
    
        /** Return whether {@link #setPMvCullingEnabled(bool) Project-Modelview (PMv) frustum culling} is enabled for this container. */
        virtual bool isPMvCullingEnabled() const noexcept = 0;
    
        /**
         * Return whether {@link #setPMvCullingEnabled(bool) Project-Modelview (PMv) frustum culling}
         * or {@link Group#setClipMvFrustum(com.jogamp.math.geom.Frustum) Group's Modelview (Mv) frustum clipping}
         * is enabled for this container. Default is disabled.
         */
        virtual bool isCullingEnabled() const noexcept = 0;
    
        /**
         * Returns whether the given {@link Shape} is completely outside of this container.
         * <p>
         * Note: If method returns false, the box may only be partially inside, i.e. intersects with this container
         * </p>
         * @param pmv current {@link PMVMatrix4f} of this container
         * @param shape the {@link Shape} to test
         * @see #isOutside2(Matrix4f, Shape, PMVMatrix4f)
         * @see Shape#isOutside()
         */
        virtual bool isOutside(const PMVMat4f&, const Shape& shape) const noexcept = 0;
    
        /**
         * Returns whether the given {@link Shape} is completely outside of this container.
         * <p>
         * Note: If method returns false, the box may only be partially inside, i.e. intersects with this container
         * </p>
         * @param mvCont copy of the model-view {@link Matrix4f) of this container
         * @param shape the {@link Shape} to test
         * @param pmvShape current {@link PMVMatrix4f} of the shape to test
         * @see #isOutside(PMVMatrix4f, Shape)
         * @see Shape#isOutside()
         */
        virtual bool isOutside2(const Mat4f& mvCont, const Shape& shape, const PMVMat4f&) const noexcept = 0;
    };
     
    /**@}*/
 
} // namespace gamp::graph::ui
 
#endif /* JAU_GAMP_GRAPH_UI_CONTAINER_HPP_ */