PLaSK library

Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
plask::StackContainerBaseImpl< dim, growingDirection > Struct Template Reference
Geometry Objects

Common code for stack containers (which have children in stack/layers). More...

`#include <plask/geometry/stack.hpp>`

Inheritance diagram for plask::StackContainerBaseImpl< dim, growingDirection >:
[legend]
Collaboration diagram for plask::StackContainerBaseImpl< dim, growingDirection >:
[legend]

## Public Types
typedef GeometryObjectContainer< dim > | BaseClass
typedef BaseClass::DVec | DVec
| Vector of doubles type in space on this, vector in space with dim number of dimensions.
typedef BaseClass::Box | Box
| Rectangle type in space on this, rectangle in space with dim number of dimensions.
typedef BaseClass::ChildType | ChildType
| Type of this child.
typedef BaseClass::TranslationT | TranslationT
| Type of translation geometry element in space of this.
typedef BaseClass::TranslationVector | TranslationVector
| Type of the vector holding container children.
Public Types inherited from plask::GeometryObjectContainer< dim >
typedef GeometryObjectContainer< dim >::DVec | DVec
| Vector of doubles type in space on this, vector in space with dim number of dimensions.
typedef GeometryObjectContainer< dim >::Box | Box
| Rectangle type in space on this, rectangle in space with dim number of dimensions.
typedef GeometryObjectD< dim > | ChildType
| Type of the container children.
typedef Translation< dim > | TranslationT
| Type of translation geometry object in space of this.
typedef std::vector< shared_ptr< TranslationT > > | TranslationVector
| Type of the vector holding container children.
Public Types inherited from plask::GeometryObjectD< dim >
typedef Primitive< dim >::Box | Box
typedef Primitive< dim >::DVec | DVec
Public Types inherited from plask::GeometryObject
enum | Type { TYPE_LEAF = 0 , TYPE_TRANSFORM = 1 , TYPE_SPACE_CHANGER = 2 , TYPE_CONTAINER = 3 , TYPE_GEOMETRY = 4 , TYPE_SEPARATOR = 5 }
| Type of geometry object. More...
typedef std::function< bool(const GeometryObject &)> | Predicate
| Predicate on GeometryObject.

## Public Member Functions
| StackContainerBaseImpl (const double baseHeight=0.0)
double | getBaseHeight () const
| Get component of position in growing direction where stack starts.
void | setBaseHeight (double newBaseHeight)
| Set height where should start first object.
void | setZeroBefore (std::size_t index)
| Set zero coordinate at the bottom of the specified object.
void | setZeroBefore (const shared_ptr< ChildType > &object, const PathHints *path=0)
| Set zero coordinate at the bottom of the specified object.
void | setZeroBefore (const shared_ptr< ChildType > &object, const PathHints &path)
| Set zero coordinate at the bottom of the specified object.
void | alignZeroOn (std::size_t index, double pos=0.)
| Align zero coordinate with the specified position of the object of specified index.
void | alignZeroOn (const shared_ptr< ChildType > &object, const PathHints *path=0, double pos=0.)
| Align zero coordinate with the zero of the specified object.
void | alignZeroOn (const shared_ptr< ChildType > &object, const PathHints &path, double pos=0.)
| Align zero coordinate with the zero of the specified object.
std::size_t | getInsertionIndexForHeight (double height) const
const shared_ptr< TranslationT > | getChildForHeight (double height, shared_ptr< TranslationT > &sec_candidate) const
const shared_ptr< TranslationT > | getChildForHeight (double height) const
bool | contains (const DVec &p) const override
shared_ptr< Material > | getMaterial (const DVec &p) const override
GeometryObject::Subtree | getPathsAt (const DVec &point, bool all=false) const override
bool | removeIfTUnsafe (const std::function< bool(const shared_ptr< TranslationT > &c)> &predicate) override
| Remove all children which fulfil predicate.
void | removeAtUnsafe (std::size_t index) override
| Remove child at given `index`.
void | onChildChanged (const GeometryObject::Event &evt) override
| Called by child.change signal, update heights call this change.
double | getHeight () const
| Get height of stack.
Public Member Functions inherited from plask::GeometryObjectContainer< dim >
virtual void | writeXML (XMLWriter::Element &parent_xml_object, GeometryObject::WriteXMLCallback &write_cb, AxisNames axes) const override
| Call writeXMLAttr for this container attribute and writeXMLChildAttr for each child tag.
| ~GeometryObjectContainer ()
| Disconnect onChildChanged from current child change signal.
void | connectOnChildChanged (Translation< dim > &child)
| Connect onChildChanged to current child change signal.
void | disconnectOnChildChanged (Translation< dim > &child)
| Disconnect onChildChanged from current child change signal.
const TranslationVector & | getChildrenVector () const
| Get physically stored children (with translations).
GeometryObject::Type | getType () const override
bool | contains (const DVec &p) const override
Box | getBoundingBox () const override
| Calculate minimal rectangle which contains all points of geometry object.
shared_ptr< Material > | getMaterial (const DVec &p) const override
| Iterate over children in reverse order and check if any returns material.
void | getBoundingBoxesToVec (const GeometryObject::Predicate &predicate, std::vector< Box > &dest, const PathHints *path=0) const override
void | getObjectsToVec (const GeometryObject::Predicate &predicate, std::vector< shared_ptr< const GeometryObject > > &dest, const PathHints *path=0) const override
| Append all objects from subtree with this in root, which fulfill predicate to vector `dest`.
virtual void | getPositionsToVec (const GeometryObject::Predicate &predicate, std::vector< DVec > &dest, const PathHints *path=0) const override
bool | hasInSubtree (const GeometryObject &el) const override
| Check if el is in subtree with `this` in root.
template<typename ChildIter >
GeometryObject::Subtree | findPathsFromChildTo (ChildIter childBegin, ChildIter childEnd, const GeometryObject &el, const PathHints *path=0) const
GeometryObject::Subtree | getPathsTo (const GeometryObject &el, const PathHints *path=0) const override
| Find paths to el.
GeometryObject::Subtree | getPathsAt (const DVec &point, bool all=false) const override
std::size_t | getChildrenCount () const override
| Get number of all children of this in geometry graph.
shared_ptr< GeometryObject > | getChildNo (std::size_t child_no) const override
| Get child with given index.
std::size_t | getChildIndex (const shared_ptr< ChildType > &el, const PathHints *path=0) const
| Return index of the given item.
std::size_t | getChildIndex (const shared_ptr< ChildType > &el, const PathHints &path) const
| Return index of the given item.
virtual shared_ptr< const GeometryObject > | changedVersion (const GeometryObject::Changer &changer, Vec< 3, double > *translation=0) const override
| Get this or copy of this with some changes in subtree.
bool | removeIfT (const std::function< bool(const shared_ptr< TranslationT > &c)> &predicate)
| Remove all children which fulfil predicate.
bool | removeIf (const std::function< bool(const shared_ptr< ChildType > &c)> &predicate)
| Remove all children which fulfil predicate.
bool | removeT (shared_ptr< const TranslationT > el)
| Remove all children exactly equal to el.
bool | remove (shared_ptr< const ChildType > el)
| Remove all children exactly equal to el.
bool | remove (const PathHints &hints)
| Remove child pointed, for this container, in hints.
void | clear ()
| Remove all children from the container.
template<typename UnaryFunction >
void | forEachChild (UnaryFunction fun, const PathHints *path=nullptr) const
| Call fun(child) for each real child of this.
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
Public Member Functions inherited from plask::GeometryObjectD< dim >
int | getDimensionsCount () const override
| Get number of dimensions.
virtual Subtree | getPathsAt (const DVec &point, bool all=false) const =0
| Find all paths to objects which lies at given `point`.
virtual bool | contains (const DVec &point) const =0
| Check if this geometry object contains point.
virtual DVec | getBoundingBoxSize () const
virtual Box | getRealBoundingBox () const
| Calculate minimal rectangle which contains all points of real geometry object.
virtual shared_ptr< Material > | getMaterial (const DVec &p) const =0
| Return material in a given point inside the geometry object.
shared_ptr< Material > | getMaterialOrAir (const DVec &p) const
| Return material in a given point inside the geometry object.
virtual void | getBoundingBoxesToVec (const GeometryObject::Predicate &predicate, std::vector< Box > &dest, const PathHints *path=0) const =0
| Calculate and append to vector bounding boxes of all nodes which fulfill given `predicate`, optionally marked by path.
void | getBoundingBoxesToVec (const GeometryObject::Predicate &predicate, std::vector< Box > &dest, const PathHints &path) const
| Calculate and append to vector bounding boxes of all nodes which fulfill given `predicate`, marked by path.
std::vector< Box > | getBoundingBoxes (const GeometryObject::Predicate &predicate, const PathHints *path=0) const
| Calculate the vector of bounding boxes of all nodes which fulfill given `predicate`, optionally marked by path.
std::vector< Box > | getBoundingBoxes (const GeometryObject::Predicate &predicate, const PathHints &path)
| Calculate the vector of bounding boxes of all nodes which fulfill given `predicate`, marked by path.
void | getLeafsBoundingBoxesToVec (std::vector< Box > &dest, const PathHints *path=0) const
| Calculate and append to vector bounding boxes of all leafs, optionally marked by path.
void | getLeafsBoundingBoxesToVec (std::vector< Box > &dest, const PathHints &path) const
| Calculate and append to vector bounding boxes of all leafs, marked by path.
std::vector< Box > | getLeafsBoundingBoxes (const PathHints *path=0) const
| Calculate bounding boxes of all leafs, optionally marked by path.
std::vector< Box > | getLeafsBoundingBoxes (const PathHints &path) const
| Calculate bounding boxes of all leafs, marked by path.
void | getObjectBoundingBoxesToVec (std::vector< Box > &dest, const GeometryObject &object, const PathHints *path=0) const
| Calculate and append to vector bounding boxes of all instances of given `object`, optionally marked by path.
void | getObjectBoundingBoxesToVec (std::vector< Box > &dest, const GeometryObject &object, const PathHints &path) const
| Calculate and append to vector bounding boxes of all instances of given `object`, marked by path.
std::vector< Box > | getObjectBoundingBoxes (const GeometryObject &object, const PathHints *path=0) const
| Calculate bounding boxes of all instances of given `object`, optionally marked by path.
std::vector< Box > | getObjectBoundingBoxes (const GeometryObject &object, const PathHints &path) const
| Calculate bounding boxes of all instances of given `objects`, marked by `path`.
virtual void | getPositionsToVec (const Predicate &predicate, std::vector< DVec > &dest, const PathHints *path=0) const =0
| Calculate and append to vector positions of all nodes which fulfill given `predicate`, optionally marked by path.
void | getPositionsToVec (const Predicate &predicate, std::vector< DVec > &dest, const PathHints &path) const
| Calculate and append to vector positions of all nodes which fulfill given `predicate`, marked by path.
std::vector< DVec > | getPositions (const Predicate &predicate, const PathHints *path=0) const
| Calculate and append to vector positions of all nodes which fulfill given `predicate`, optionally marked by path.
std::vector< DVec > | getPositions (const Predicate &predicate, const PathHints &path) const
| Calculate and append to vector positions of all nodes which fulfill given `predicate`, marked by path.
void | getLeafsPositionsToVec (std::vector< DVec > &dest, const PathHints *path=0) const
| Calculate and append to vector positions of all leafs, optionally marked by path.
void | getLeafsPositionsToVec (std::vector< DVec > &dest, const PathHints &path) const
| Calculate and append to vector positions of all leafs, marked by path.
std::vector< DVec > | getLeafsPositions (const PathHints *path=0) const
| Calculate and return a vector of positions of all leafs, optionally marked by path.
std::vector< DVec > | getLeafsPositions (const PathHints &path) const
| Calculate and return a vector of positions of all leafs, marked by path.
void | getObjectPositionsToVec (std::vector< DVec > &dest, const GeometryObject &object, const PathHints *path=0) const
| Calculate and append to vector positions of all instances of given `object`, optionally marked by path.
void | getObjectPositionsToVec (std::vector< DVec > &dest, const GeometryObject &object, const PathHints &path) const
| Calculate and append to vector positions of all instances of given `object`, marked by path.
std::vector< DVec > | getObjectPositions (const GeometryObject &object, const PathHints *path=0) const
| Calculate and return a vector of positions of all instances of given `object`, optionally marked by path.
std::vector< DVec > | getObjectPositions (const GeometryObject &object, const PathHints &path) const
| Calculate and return a vector of positions of all instances of given `object`, marked by path.
shared_ptr< const GeometryObject > | getMatchingAt (const DVec &point, const Predicate &predicate, const PathHints *path=0) const
| Get object closest to the root, which contains specific point and fulfills the predicate.
shared_ptr< const GeometryObject > | getMatchingAt (const DVec &point, const Predicate &predicate, const PathHints &path) const
| Get object closest to the root, which contains specific point and fulfills the predicate.
bool | objectIncludes (const GeometryObject &object, const PathHints *path, const DVec &point) const
| Check if specified geometry object contains a point point.
bool | objectIncludes (const GeometryObject &object, const PathHints &path, const DVec &point) const
| Check if specified geometry object contains a point point.
bool | objectIncludes (const GeometryObject &object, const DVec &point) const
| Check if specified geometry object contains a point point.
std::set< std::string > | getRolesAt (const DVec &point, const plask::PathHints *path=0) const
| Get a sum of roles sets of all objects which lies on path from this to leaf at given `point`.
std::set< std::string > | getRolesAt (const DVec &point, const plask::PathHints &path) const
| Get a sum of roles sets of all objects which lies on path from this to leaf at given `point`.
shared_ptr< const GeometryObject > | hasRoleAt (const std::string &role_name, const DVec &point, const plask::PathHints *path=0) const
| Check if any object at given `point`, not hidden by another object, plays role with given name `role_name` (if so, returns non-nullptr).
shared_ptr< const GeometryObject > | hasRoleAt (const std::string &role_name, const DVec &point, const plask::PathHints &path) const
| Check if any object at given `point`, not hidden by another object, plays role with given name `role_name` (if so, returns non-nullptr).
virtual void | addLineSegmentsToSet (std::set< LineSegment > &PLASK_UNUSED(segments), unsigned PLASK_UNUSED(max_steps), double PLASK_UNUSED(min_step_size)) const =0
| Add characteristic points to the set and edges connecting them.
std::set< LineSegment > | getLineSegments (unsigned max_steps=PLASK_GEOMETRY_MAX_STEPS, double min_step_size=PLASK_GEOMETRY_MIN_STEP_SIZE) const
| Add characteristic points to the set and edges connecting them.
virtual Subtree | getPathsTo (const GeometryObject &el, const PathHints *pathHints=0) const=0
| Find paths to el.
Public Member Functions inherited from plask::GeometryObject
void | setMaxSteps (unsigned value)
| Set max_steps.
void | setMinStepSize (double value)
| Set min_step_size.
template<typename ClassT , typename methodT >
boost::signals2::connection | changedConnectMethod (ClassT *obj, methodT method, boost::signals2::connect_position at=boost::signals2::at_back)
| Connect a method to changed signal.
template<typename ClassT , typename methodT >
void | changedDisconnectMethod (ClassT *obj, methodT method)
| Disconnect a method from changed signal.
template<typename EventT = Event, typename... Args>
void | fireChanged (Args &&... event_constructor_params_without_source)
| Call changed with this as event source.
| GeometryObject (const GeometryObject &to_copy)
| Initialize this to be the same as `to_copy` but doesn't have any changes observer.
GeometryObject & | operator= (const GeometryObject &to_copy)
| Set this to be the same as `to_copy` but doesn't change changes observer.
| GeometryObject ()
| GeometryObject (unsigned max_steps, double min_step_size)
virtual | ~GeometryObject ()
| Virtual destructor.
virtual std::string | getTypeName () const =0
| Get name of object type (like: "block2d", "shelf", "stack3d", etc.).
void | writeXML (XMLWriter::Element &parent_xml_object, WriteXMLCallback &write_cb) const
| Write geometry tree branch rooted by this to XML.
void | writeXML (XMLWriter::Element &parent_xml_object) const
| Write geometry tree branch rooted by this to XML.
template<int DIMS>
shared_ptr< GeometryObjectD< DIMS > > | asD ()
| Cast this to GeometryObjectD<DIMS>.
template<int DIMS>
shared_ptr< const GeometryObjectD< DIMS > > | asD () const
| Cast this to GeometryObjectD<DIMS> (const version).
shared_ptr< Geometry > | asGeometry ()
| Cast this to Geometry.
shared_ptr< const Geometry > | asGeometry () const
| Cast this to Geometry.
bool | isLeaf () const
bool | isTransform () const
bool | isSpaceChanger () const
bool | isContainer () const
bool | isGeometry () const
virtual void | addPointsAlongToSet (std::set< double > &points, Primitive< 3 >::Direction PLASK_UNUSED(direction), unsigned PLASK_UNUSED(max_steps), double PLASK_UNUSED(min_step_size)) const =0
| Add characteristic points information along specified axis to set.
std::set< double > | getPointsAlong (Primitive< 3 >::Direction direction, unsigned max_steps=PLASK_GEOMETRY_MAX_STEPS, double min_step_size=PLASK_GEOMETRY_MIN_STEP_SIZE) const
| Get characteristic points information along specified axis.
bool | hasRole (std::string role_name) const
| Check if this object belongs to class (has tag) with name `role_name`.
void | addRole (std::string role_name)
| Add this to given class.
void | removeRole (std::string role_name)
| Remove this from given class, do nothing if this is not in given class.
void | clearRoles ()
| Clear set of roles of this.
virtual void | validate () const
| Check if object is ready for calculation.
bool | hasInSubtree (const GeometryObject &el, const PathHints *pathHints) const
bool | hasInSubtree (shared_ptr< const GeometryObject > el, const PathHints *pathHints) const
void | getObjectsToVec (const Predicate &predicate, std::vector< shared_ptr< const GeometryObject > > &dest, const PathHints &path) const
| Append all objects from subtree with this in root, which fulfill predicate to vector `dest`.
std::vector< shared_ptr< const GeometryObject > > | getObjects (const Predicate &predicate, const PathHints *path=0) const
| Get vector of all objects from subtree with this in root, which fulfill predicate.
std::vector< shared_ptr< const GeometryObject > > | getObjects (const Predicate &predicate, const PathHints &path) const
| Get vector of all objects from subtree with this in root, which fulfill predicate.
void | getLeafsToVec (std::vector< shared_ptr< const GeometryObject > > &dest, const PathHints *path=0) const
| Append all leafs in subtree with this in root to vector `dest`.
void | getLeafsToVec (std::vector< shared_ptr< const GeometryObject > > &dest, const PathHints &path) const
| Append all leafs in subtree with this in root to vector `dest`.
std::vector< shared_ptr< const GeometryObject > > | getLeafs (const PathHints *path=0) const
| Get all leafs in subtree with this object as root.
std::vector< shared_ptr< const GeometryObject > > | getLeafs (const PathHints &path) const
| Get all leafs in subtree with this object as root.
void | getObjectsWithRoleToVec (const std::string &role, std::vector< shared_ptr< const GeometryObject > > &dest) const
| Append all objects with a specified role in subtree with this in root to vector `dest`.
std::vector< shared_ptr< const GeometryObject > > | getObjectsWithRole (const std::string &role) const
| Get all objects with a specified role in subtree with this object as root.
virtual std::size_t | getRealChildrenCount () const
| Get number of real (physically stored) children in geometry graph.
virtual shared_ptr< GeometryObject > | getRealChildNo (std::size_t child_no) const
| Get real (physically stored) child with given index.
void | removeAt (std::size_t index)
| Remove child at given `index`.
void | removeRangeUnsafe (std::size_t index_begin, std::size_t index_end)
bool | removeRange (std::size_t index_begin, std::size_t index_end)
| Remove all children in given range [index_begin, index_end).
virtual void | forEachRealObjectInSubtree (std::function< bool(const GeometryObject &)> callback) const
| Call a `callback` for each object in subtree with `this` in root.
FunctorIndexedIterator< ChildGetter > | begin () const
FunctorIndexedIterator< ChildGetter > | end () const
virtual shared_ptr< GeometryObject > | shallowCopy () const =0
| Get shallow copy of this.
virtual shared_ptr< GeometryObject > | deepCopy (std::map< const GeometryObject *, shared_ptr< GeometryObject > > &copied) const =0
| Get deep copy of this.
shared_ptr< GeometryObject > | deepCopy ()
| Get deep copy of this.
bool | canHasAsChild (const GeometryObject &potential_child) const
bool | canHasAsParent (const GeometryObject &potential_parent) const
void | ensureCanHasAsParent (const GeometryObject &potential_parent) const
| Throw CyclicReferenceException if `potential_parent` is in subtree with this in root.
void | ensureCanHaveAsChild (const GeometryObject &potential_child) const
| Throw CyclicReferenceException if `potential_child` has this in subtree.

## Public Attributes
TranslationVector | children
Public Attributes inherited from plask::GeometryObject
unsigned | max_steps
| Maximum number of points to split a single leaf.
double | min_step_size
| Minimum distance between divisions for a single leaf.
std::set< std::string > | roles
| Roles/tags.
boost::signals2::signal< void(Event &)> | changed
| Changed signal, fired when object was changed.

## Static Public Attributes
static constexpr Primitive< dim >::Direction | GROWING_DIR = growingDirection
Static Public Attributes inherited from plask::GeometryObjectD< dim >
static const int | DIM = dim

## Protected Member Functions
void | calcHeight (const Box &elBoudingBox, double prev_height, double &el_translation, double &next_height)
| Calculate object vertical translation and height of stack with object el.
void | calcHeight (const shared_ptr< ChildType > &el, double prev_height, double &el_translation, double &next_height)
| Calculate object vertical translation and height of stack with object el.
void | updateHeight (std::size_t child_index)
| Update stack height (fragment with pointed child on top) and pointed child up translation.
void | updateAllHeights (std::size_t first_child_index)
| Update stack heights and translation in stack growing direction of all children, with indexes from first_child_index.
void | updateAllHeights ()
void | rebuildStackHeights (std::size_t first_child_index=0)
| Resize stackHeights (to be compatible with children vector) and refresh its value from given index.
void | writeXMLAttr (XMLWriter::Element &dest_xml_object, const AxisNames &axes) const override
| Append XML attributes of this to `dest_xml_object`.
Protected Member Functions inherited from plask::GeometryObjectContainer< dim >
virtual void | writeXMLChildAttr (XMLWriter::Element &dest_xml_child_tag, std::size_t child_index, const AxisNames &axes) const
| Add attributes to child tag.
virtual shared_ptr< GeometryObject > | changedVersionForChildren (std::vector< std::pair< shared_ptr< ChildType >, Vec< 3, double > > > &children_after_change, Vec< 3, double > *recomended_translation) const =0
| This is called by changedVersion method to create new version of this container which consists of new children.
Protected Member Functions inherited from plask::GeometryObject
virtual void | writeXMLChildren (XMLWriter::Element &dest_xml_object, WriteXMLCallback &write_cb, const AxisNames &axes) const
| Append all children of this to XML `dest_xml_object`.
void | ensureIsValidChildNr (std::size_t child_no, const char *method_name="getChildNo", const char *arg_name="child_no") const
| Check if given `index` is valid child index and throw exception of it is not.
void | ensureIsValidInsertPosition (std::size_t child_no, const char *method_name="insert", const char *arg_name="pos") const
| Check if given `index` is valid insert index and throw exception of it is not.
void | fireChildrenChanged ()
| Inform observers that children list was changed (also that this is resized)
void | fireChildrenRemoved (std::size_t beginIndex, std::size_t endIndex)
void | fireChildrenInserted (std::size_t beginIndex, std::size_t endIndex)

## Protected Attributes
std::vector< double > | stackHeights
| stackHeights[x] is current stack heights with x first objects in it (sums of heights of first x objects), stackHeights.size() = children.size() + 1 and stackHeights[0] is a base height (typically 0.0)
Protected Attributes inherited from plask::GeometryObjectContainer< dim >
TranslationVector | children

## Additional Inherited Members
Static Public Member Functions inherited from plask::GeometryObject
static bool | PredicateIsLeaf (const GeometryObject &el)
| Predicate which check if given object is leaf.

## Detailed Description

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>
struct plask::StackContainerBaseImpl< dim, growingDirection >

Common code for stack containers (which have children in stack/layers).

Template Parameters

  dim | number of space dimensions
  growingDirection | direction in which stack growing

Definition at line 30 of file stack.hpp.

## Member Typedef Documentation

## ◆ BaseClass

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

typedef GeometryObjectContainer<dim> plask::StackContainerBaseImpl< dim, growingDirection >::BaseClass

Definition at line 32 of file stack.hpp.

## ◆ Box

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

typedef BaseClass::Box plask::StackContainerBaseImpl< dim, growingDirection >::Box

Rectangle type in space on this, rectangle in space with dim number of dimensions.

Definition at line 40 of file stack.hpp.

## ◆ ChildType

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

typedef BaseClass::ChildType plask::StackContainerBaseImpl< dim, growingDirection >::ChildType

Type of this child.

Definition at line 43 of file stack.hpp.

## ◆ DVec

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

typedef BaseClass::DVec plask::StackContainerBaseImpl< dim, growingDirection >::DVec

Vector of doubles type in space on this, vector in space with dim number of dimensions.

Definition at line 37 of file stack.hpp.

## ◆ TranslationT

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

typedef BaseClass::TranslationT plask::StackContainerBaseImpl< dim, growingDirection >::TranslationT

Type of translation geometry element in space of this.

Definition at line 46 of file stack.hpp.

## ◆ TranslationVector

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

typedef BaseClass::TranslationVector plask::StackContainerBaseImpl< dim, growingDirection >::TranslationVector

Type of the vector holding container children.

Definition at line 49 of file stack.hpp.

## Constructor & Destructor Documentation

## ◆ StackContainerBaseImpl()

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

plask::StackContainerBaseImpl< dim, growingDirection >::StackContainerBaseImpl | ( | const double | baseHeight = `0.0` | ) |
| inline explicit

Parameters

  baseHeight | height where should start first object

Definition at line 56 of file stack.hpp.

## Member Function Documentation

## ◆ alignZeroOn() [1/3]

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

void plask::StackContainerBaseImpl< dim, growingDirection >::alignZeroOn | ( | const shared_ptr< ChildType > & | object,
|  | const PathHints & | path,
|  | double | pos = `0.`
| ) |  |
| inline

Align zero coordinate with the zero of the specified object.

Parameters

  object | object which should be aligned
  path | path to object which should be aligned
  pos | local object position to align stack zero

Definition at line 119 of file stack.hpp.

## ◆ alignZeroOn() [2/3]

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

void plask::StackContainerBaseImpl< dim, growingDirection >::alignZeroOn | ( | const shared_ptr< ChildType > & | object,
|  | const PathHints * | path = `0`,
|  | double | pos = `0.`
| ) |  |
| inline

Align zero coordinate with the zero of the specified object.

Parameters

  object | object which should be aligned
  path | path to object which should be aligned
  pos | local object position to align stack zero

Definition at line 109 of file stack.hpp.

## ◆ alignZeroOn() [3/3]

template<int dim, typename Primitive< dim >::Direction growingDirection>

void plask::StackContainerBaseImpl< dim, growingDirection >::alignZeroOn | ( | std::size_t | index,
|  | double | pos = `0.`
| ) |  |

Align zero coordinate with the specified position of the object of specified index.

Parameters

  index | index of object which should be aligned
  pos | local object position to align stack zero

Definition at line 53 of file stack.cpp.

## ◆ calcHeight() [1/2]

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

void plask::StackContainerBaseImpl< dim, growingDirection >::calcHeight | ( | const Box & | elBoudingBox,
|  | double | prev_height,
|  | double & | el_translation,
|  | double & | next_height
| ) |  |
| inline protected

Calculate object vertical translation and height of stack with object el.

Parameters

  [in] | elBoudingBox | bounding box of geometry object (typically: for object which is or will be in stack)
  [in] | prev_height | height of stack under an el
  [out] | el_translation | up translation which should object el have
  [out] | next_height | height of stack with an el on top (up to el)

Definition at line 173 of file stack.hpp.

## ◆ calcHeight() [2/2]

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

void plask::StackContainerBaseImpl< dim, growingDirection >::calcHeight | ( | const shared_ptr< ChildType > & | el,
|  | double | prev_height,
|  | double & | el_translation,
|  | double & | next_height
| ) |  |
| inline protected

Calculate object vertical translation and height of stack with object el.

Parameters

  [in] | el | geometry object (typically: which is or will be in stack)
  [in] | prev_height | height of stack under an el
  [out] | el_translation | up translation which should object el have
  [out] | next_height | height of stack with an el on top (up to el)

Definition at line 185 of file stack.hpp.

## ◆ contains()

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

bool plask::StackContainerBaseImpl< dim, growingDirection >::contains | ( | const DVec & | p | ) | const
| override

Definition at line 93 of file stack.cpp.

## ◆ getBaseHeight()

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

double plask::StackContainerBaseImpl< dim, growingDirection >::getBaseHeight | ( |  | ) | const
| inline

Get component of position in growing direction where stack starts.

Returns
  component of position in growing direction where stack starts

Definition at line 64 of file stack.hpp.

## ◆ getChildForHeight() [1/2]

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

const shared_ptr< TranslationT > plask::StackContainerBaseImpl< dim, growingDirection >::getChildForHeight | ( | double | height | ) | const
| inline

Definition at line 132 of file stack.hpp.

## ◆ getChildForHeight() [2/2]

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

const shared_ptr< TranslationT > plask::StackContainerBaseImpl< dim, growingDirection >::getChildForHeight | ( | double | height,
|  | shared_ptr< TranslationT > & | sec_candidate
| ) |  | const

Parameters

  height |
  sec_candidate[out] | child which can be at given height

Returns
  child which can be at given height or `nullptr` (than sec_candidate is also not set)

## ◆ getHeight()

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

double plask::StackContainerBaseImpl< dim, growingDirection >::getHeight | ( |  | ) | const
| inline

Get height of stack.

Returns
  height of stack, size of stack in growing direction

Definition at line 154 of file stack.hpp.

## ◆ getInsertionIndexForHeight()

template<int dim, typename Primitive< dim >::Direction growingDirection>

std::size_t plask::StackContainerBaseImpl< dim, growingDirection >::getInsertionIndexForHeight | ( | double | height | ) | const

Definition at line 62 of file stack.cpp.

## ◆ getMaterial()

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

shared_ptr< Material > plask::StackContainerBaseImpl< dim, growingDirection >::getMaterial | ( | const DVec & | p | ) | const
| override

Definition at line 105 of file stack.cpp.

## ◆ getPathsAt()

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

GeometryObject::Subtree plask::StackContainerBaseImpl< dim, growingDirection >::getPathsAt | ( | const DVec & | point,
|  | bool | all = `false`
| ) |  | const
| override

Definition at line 117 of file stack.cpp.

## ◆ onChildChanged()

template<int dim, typename Primitive< dim >::Direction growingDirection>

void plask::StackContainerBaseImpl< dim, growingDirection >::onChildChanged | ( | const GeometryObject::Event & | evt | ) |
| override virtual

Called by child.change signal, update heights call this change.

Reimplemented from plask::GeometryObjectContainer< dim >.

Reimplemented in plask::WithAligners< StackContainerBaseImpl< dim >, StackContainerChildAligner< dim > >.

Definition at line 150 of file stack.cpp.

## ◆ rebuildStackHeights()

template<int dim, typename Primitive< dim >::Direction growingDirection>

void plask::StackContainerBaseImpl< dim, growingDirection >::rebuildStackHeights | ( | std::size_t | first_child_index = `0` | ) |
| protected

Resize stackHeights (to be compatible with children vector) and refresh its value from given index.

Parameters

  first_child_index | index of first child for which stackHeights should be update

Definition at line 177 of file stack.cpp.

## ◆ removeAtUnsafe()

template<int dim, typename Primitive< dim >::Direction growingDirection>

void plask::StackContainerBaseImpl< dim, growingDirection >::removeAtUnsafe | ( | std::size_t | index | ) |
| override virtual

Remove child at given `index`.

This is unsafe but fast version, it doesn't check index and doesn't call fireChildrenChanged() to inform listeners about this object changes. Caller should do this manually or call removeAt(std::size_t) instead.

Parameters

  index | index of real child to remove

Reimplemented from plask::GeometryObjectContainer< dim >.

Reimplemented in plask::WithAligners< StackContainerBaseImpl< dim >, StackContainerChildAligner< dim > >.

Definition at line 143 of file stack.cpp.

## ◆ removeIfTUnsafe()

template<int dim, typename Primitive< dim >::Direction growingDirection>

bool plask::StackContainerBaseImpl< dim, growingDirection >::removeIfTUnsafe | ( | const std::function< bool(const shared_ptr< TranslationT > &c)> & | predicate | ) |
| override virtual

Remove all children which fulfil predicate.

This is unsafe but fast version, it doesn't call fireChildrenChanged() to inform listeners about this object changes. Caller should do this manually or call removeIfT instead.

Parameters

  predicate | returns true only if the child (with translation) passed as an argument should be deleted

Returns
  true if anything has been removed

Reimplemented from plask::GeometryObjectContainer< dim >.

Definition at line 190 of file stack.cpp.

## ◆ setBaseHeight()

template<int dim, typename Primitive< dim >::Direction growingDirection>

void plask::StackContainerBaseImpl< dim, growingDirection >::setBaseHeight | ( | double | newBaseHeight | ) |

Set height where should start first object.

Call changed.

Parameters

  newBaseHeight | where lower bound of the lowest object should be

Definition at line 29 of file stack.cpp.

## ◆ setZeroBefore() [1/3]

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

void plask::StackContainerBaseImpl< dim, growingDirection >::setZeroBefore | ( | const shared_ptr< ChildType > & | object,
|  | const PathHints & | path
| ) |  |
| inline

Set zero coordinate at the bottom of the specified object.

Parameters

  object | object which lower bound should lie at height 0
  path | path to object which lower bound should lie at height 0

Definition at line 92 of file stack.hpp.

## ◆ setZeroBefore() [2/3]

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

void plask::StackContainerBaseImpl< dim, growingDirection >::setZeroBefore | ( | const shared_ptr< ChildType > & | object,
|  | const PathHints * | path = `0`
| ) |  |
| inline

Set zero coordinate at the bottom of the specified object.

Parameters

  object | object which lower bound should lie at height 0
  path | path to object which lower bound should lie at height 0

Definition at line 83 of file stack.hpp.

## ◆ setZeroBefore() [3/3]

template<int dim, typename Primitive< dim >::Direction growingDirection>

void plask::StackContainerBaseImpl< dim, growingDirection >::setZeroBefore | ( | std::size_t | index | ) |

Set zero coordinate at the bottom of the specified object.

Parameters

  index | index of object which lower bound should lie at height 0

Definition at line 46 of file stack.cpp.

## ◆ updateAllHeights() [1/2]

template<int dim, typename Primitive< dim >::Direction growingDirection>

void plask::StackContainerBaseImpl< dim, growingDirection >::updateAllHeights | ( |  | ) |
| protected

Definition at line 164 of file stack.cpp.

## ◆ updateAllHeights() [2/2]

template<int dim, typename Primitive< dim >::Direction growingDirection>

void plask::StackContainerBaseImpl< dim, growingDirection >::updateAllHeights | ( | std::size_t | first_child_index | ) |
| protected

Update stack heights and translation in stack growing direction of all children, with indexes from first_child_index.

Parameters

  first_child_index | index of first child for which stackHeights should be update

to use AccurateSum

Definition at line 157 of file stack.cpp.

## ◆ updateHeight()

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

void plask::StackContainerBaseImpl< dim, growingDirection >::updateHeight | ( | std::size_t | child_index | ) |
| inline protected

Update stack height (fragment with pointed child on top) and pointed child up translation.

Parameters

  child_index | index of child

Definition at line 193 of file stack.hpp.

## ◆ writeXMLAttr()

template<int dim, typename Primitive< dim >::Direction growingDirection>

void plask::StackContainerBaseImpl< dim, growingDirection >::writeXMLAttr | ( | XMLWriter::Element & | dest_xml_object,
|  | const AxisNames & | axes
| ) |  | const
| override protected virtual

Append XML attributes of this to `dest_xml_object`.

By default do nothing.

Parameters

  dest_xml_object | XML tag where attributes should be append
  axes | chosen name of axes

Reimplemented from plask::GeometryObject.

Definition at line 183 of file stack.cpp.

## Member Data Documentation

## ◆ children

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

TranslationVector plask::GeometryObjectContainer< dim >::children

Definition at line 58 of file container.hpp.

## ◆ GROWING_DIR

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

constexpr Primitive<dim>::Direction plask::StackContainerBaseImpl< dim, growingDirection >::GROWING_DIR = growingDirection
| static constexpr

Definition at line 34 of file stack.hpp.

## ◆ stackHeights

template<int dim, typename Primitive< dim >::Direction growingDirection = Primitive<dim>::DIRECTION_VERT>

std::vector<double> plask::StackContainerBaseImpl< dim, growingDirection >::stackHeights
| protected

stackHeights[x] is current stack heights with x first objects in it (sums of heights of first x objects), stackHeights.size() = children.size() + 1 and stackHeights[0] is a base height (typically 0.0)

Definition at line 164 of file stack.hpp.

The documentation for this struct was generated from the following files:

- plask/geometry/stack.hpp
- plask/geometry/stack.cpp