clip.hpp

Go to the documentation of this file.

/* 
 * This file is part of PLaSK (https://plask.app) by Photonics Group at TUL
 * Copyright (c) 2022 Lodz University of Technology
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */
#ifndef PLASK__GEOMETRY_CLIP_H
#define PLASK__GEOMETRY_CLIP_H
 
#include "transform.hpp"
 
namespace plask {
 
template <int dim> struct PLASK_API Clip : public GeometryObjectTransform<dim> {
    static const char* NAME;
 
    std::string getTypeName() const override { return NAME; }
 
    typedef typename GeometryObjectTransform<dim>::ChildType ChildType;
 
    typedef typename GeometryObjectTransform<dim>::DVec DVec;
 
    typedef typename GeometryObjectTransform<dim>::Box Box;
 
    using GeometryObjectTransform<dim>::getChild;
 
    Box clipBox;
 
    // Clip(const Clip<dim>& tocpy) = default;
 
    explicit Clip(shared_ptr<GeometryObjectD<dim>> child = shared_ptr<GeometryObjectD<dim>>(),
                  const Box& clipBox = Primitive<dim>::INF_BOX)
        : GeometryObjectTransform<dim>(child), clipBox(clipBox) {}
 
    explicit Clip(GeometryObjectD<dim>& child, const Box& clipBox = Primitive<dim>::INF_BOX)
        : GeometryObjectTransform<dim>(child), clipBox(clipBox) {}
 
    shared_ptr<Material> getMaterial(const DVec& p) const override;
 
    bool contains(const DVec& p) const override;
 
    using GeometryObjectTransform<dim>::getPathsTo;
 
    GeometryObject::Subtree getPathsAt(const DVec& point, bool all = false) const override;
 
    Box fromChildCoords(const typename ChildType::Box& child_bbox) const override;
 
    virtual void getPositionsToVec(const GeometryObject::Predicate& predicate,
                                   std::vector<DVec>& dest,
                                   const PathHints* path = 0) const override;
 
    shared_ptr<Clip<dim>> copyShallow() const { return plask::make_shared<Clip<dim>>(getChild(), clipBox); }
 
    shared_ptr<GeometryObject> shallowCopy() const override;
 
    shared_ptr<Clip<dim>> copyShallow(const Box& new_clip) const {
        return plask::make_shared<Clip<dim>>(getChild(), new_clip);
    }
 
    void addPointsAlongToSet(std::set<double>& points,
                             Primitive<3>::Direction direction,
                             unsigned max_steps,
                             double min_step_size) const override;
 
    void addLineSegmentsToSet(std::set<typename GeometryObjectD<dim>::LineSegment>& segments,
                              unsigned max_steps,
                              double min_step_size) const override;
 
  protected:
    void writeXMLAttr(XMLWriter::Element& dest_xml_object, const AxisNames& axes) const override;
 
  private:
    void addClippedSegment(std::set<typename GeometryObjectD<dim>::LineSegment>& segments, DVec p0, DVec p1) const;
};
 
template <> void Clip<2>::writeXMLAttr(XMLWriter::Element& dest_xml_object, const AxisNames& axes) const;
template <> void Clip<3>::writeXMLAttr(XMLWriter::Element& dest_xml_object, const AxisNames& axes) const;
 
PLASK_API_EXTERN_TEMPLATE_STRUCT(Clip<2>)
PLASK_API_EXTERN_TEMPLATE_STRUCT(Clip<3>)
 
}  // namespace plask
 
#endif  // PLASK__GEOMETRY_CLIP_H