Represent geometry object equal to its child clipped to given box. More...

#include <plask/geometry/clip.hpp>

Inheritance diagram for plask::Clip< dim >:

Collaboration diagram for plask::Clip< dim >:

Public Types
typedef GeometryObjectTransform< dim >::ChildType	ChildType

typedef GeometryObjectTransform< dim >::DVec	DVec
	Vector of doubles type in space on this, vector in space with dim number of dimensions.

typedef GeometryObjectTransform< dim >::Box	Box
	Box type in space on this, rectangle in space with dim number of dimensions.

Public Types inherited from plask::GeometryObjectTransform< dim, Child_Type >
typedef GeometryObjectD< dim >::DVec	DVec

typedef GeometryObjectD< dim >::Box	Box

typedef Child_Type	ChildType

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
std::string	getTypeName () const override
	Get name of object type (like: "block2d", "shelf", "stack3d", etc.).

	Clip (shared_ptr< GeometryObjectD< dim > > child=shared_ptr< GeometryObjectD< dim > >(), const Box &clipBox=Primitive< dim >::INF_BOX)

	Clip (GeometryObjectD< dim > &child, const Box &clipBox=Primitive< dim >::INF_BOX)

shared_ptr< Material >	getMaterial (const DVec &p) const override
	Return material in a given point inside the geometry object.

bool	contains (const DVec &p) const override
	Check if this geometry object contains point.

GeometryObject::Subtree	getPathsAt (const DVec &point, bool all=false) const override
	Find all paths to objects which lies at given `point`.

Box	fromChildCoords (const typename ChildType::Box &child_bbox) const override
	Convert bounding box from child's to this's coordinates.

virtual void	getPositionsToVec (const GeometryObject::Predicate &predicate, std::vector< DVec > &dest, const PathHints *path=0) const override
	Calculate and append to vector positions of all nodes which fulfill given `predicate`, optionally marked by path.

shared_ptr< Clip< dim > >	copyShallow () const
	Get shallow copy of this.

shared_ptr< GeometryObject >	shallowCopy () const override
	Get shallow copy of this.

shared_ptr< Clip< dim > >	copyShallow (const Box &new_clip) const
	Get shallow copy of this with different clip box.

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::GeometryObjectTransform< dim, Child_Type >
	GeometryObjectTransform (shared_ptr< ChildType > child=nullptr)

	GeometryObjectTransform (ChildType &child)

virtual	~GeometryObjectTransform ()

GeometryObject::Type	getType () const override
	Check if geometry is: leaf, transform or container type object.

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	onChildChanged (const GeometryObject::Event &evt)
	Called by child.change signal, call this change.

void	connectOnChildChanged ()
	Connect onChildChanged to current child change signal.

void	disconnectOnChildChanged ()
	Disconnect onChildChanged from current child change signal.

shared_ptr< ChildType >	getChild () const
	Get child.

void	setChildUnsafe (const shared_ptr< ChildType > &child)
	Set new child.

void	setChild (const shared_ptr< ChildType > &child)
	Set new child.

bool	hasChild () const

void	validate () const override
	Throws NoChildException if child is not set.

bool	hasInSubtree (const GeometryObject &el) const override
	Check if el is in subtree with `this` in root.

GeometryObject::Subtree	getPathsTo (const GeometryObject &el, const PathHints *path=0) const override
	Find paths to el.

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.

shared_ptr< GeometryObjectTransform< dim, Child_Type > >	shallowCopyWithChild (const shared_ptr< ChildType > &child) const
	Get copy of this, and change child in the copy,.

shared_ptr< GeometryObject >	deepCopy (std::map< const GeometryObject *, shared_ptr< GeometryObject > > &copied) const override
	Get deep copy of this.

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.

void	removeAtUnsafe (std::size_t) override
	Remove child at given `index`.

Box	getBoundingBox () const override
	Calculate minimal rectangle which contains all points of geometry object.

void	getBoundingBoxesToVec (const GeometryObject::Predicate &predicate, std::vector< Box > &dest, const PathHints *path) const override
	Calculate and append to vector bounding boxes of all nodes which fulfill given `predicate`, optionally marked by path.

bool	childHasType (GeometryObject::Type type) const
	Check if child of this has given type.

Public Member Functions inherited from plask::GeometryObjectD< dim >
int	getDimensionsCount () const override
	Get number of dimensions.

virtual DVec	getBoundingBoxSize () const

virtual Box	getRealBoundingBox () const
	Calculate minimal rectangle which contains all points of real geometry object.

shared_ptr< Material >	getMaterialOrAir (const DVec &p) const
	Return material in a given point inside the geometry object.

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`.

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.

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 void	writeXML (XMLWriter::Element &parent_xml_object, WriteXMLCallback &write_cb, AxisNames parent_axes) const
	Write geometry tree branch rooted by this to XML.

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.

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

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
Box	clipBox
	Clip box.

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 const char *	NAME = dim == 2 ? PLASK_CLIP2D_NAME : PLASK_CLIP3D_NAME

Static Public Attributes inherited from plask::GeometryObjectD< dim >
static const int	DIM = dim

Protected Member Functions
void	writeXMLAttr (XMLWriter::Element &dest_xml_object, const AxisNames &axes) const override
	Append XML attributes of this to `dest_xml_object`.

void	writeXMLAttr (XMLWriter::Element &dest_xml_object, const AxisNames &axes) const
	Append XML attributes of this to `dest_xml_object`.

void	writeXMLAttr (XMLWriter::Element &dest_xml_object, const AxisNames &axes) const
	Append XML attributes of this to `dest_xml_object`.

void	writeXMLAttr (XMLWriter::Element &dest_xml_object, const AxisNames &axes) const
	Append XML attributes of this to `dest_xml_object`.

void	writeXMLAttr (XMLWriter::Element &dest_xml_object, const AxisNames &axes) const
	Append XML attributes of this to `dest_xml_object`.

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)

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.

Static Protected Member Functions inherited from plask::GeometryObjectTransform< dim, Child_Type >
template<typename ThisType >
static void	_getNotChangedPositionsToVec (ThisType _this, const GeometryObject::Predicate &predicate, std::vector< DVec > &dest, const PathHints *path)
	Possible implementation for getPositionsToVec, which does not change children position and is used by many subclasses.

Protected Attributes inherited from plask::GeometryObjectTransform< dim, Child_Type >
shared_ptr< ChildType >	_child

Detailed Description

template<int dim>
struct plask::Clip< dim >

Represent geometry object equal to its child clipped to given box.

Definition at line 25 of file clip.hpp.

Member Typedef Documentation

◆ Box

template<int dim>

typedef GeometryObjectTransform<dim>::Box plask::Clip< dim >::Box

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

Definition at line 36 of file clip.hpp.

◆ ChildType

template<int dim>

typedef GeometryObjectTransform<dim>::ChildType plask::Clip< dim >::ChildType

Definition at line 30 of file clip.hpp.

◆ DVec

template<int dim>

typedef GeometryObjectTransform<dim>::DVec plask::Clip< dim >::DVec

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

Definition at line 33 of file clip.hpp.

Constructor & Destructor Documentation

◆ Clip() [1/2]

template<int dim>

plask::Clip< dim >::Clip	(	shared_ptr< GeometryObjectD< dim > >	child = `shared_ptr<GeometryObjectD<dim>>()`,
		const Box &	clipBox = `Primitive<dim>::INF_BOX`
	)

inlineexplicit

Parameters

child	child geometry object to clip
Clip	Clip

Definition at line 51 of file clip.hpp.

◆ Clip() [2/2]

template<int dim>

plask::Clip< dim >::Clip	(	GeometryObjectD< dim > &	child,
		const Box &	clipBox = `Primitive<dim>::INF_BOX`
	)

inlineexplicit

Definition at line 55 of file clip.hpp.

Member Function Documentation

◆ addLineSegmentsToSet()

template<int dim>

void plask::Clip< dim >::addLineSegmentsToSet	(	std::set< typename GeometryObjectD< dim >::LineSegment > &	segments,
		unsigned	max_steps,
		double	min_step_size
	)		const

override

Definition at line 78 of file clip.cpp.

◆ addPointsAlongToSet()

template<int dim>

void plask::Clip< dim >::addPointsAlongToSet	(	std::set< double > &	points,
		Primitive< 3 >::Direction	direction,
		unsigned	max_steps,
		double	min_step_size
	)		const

override

Definition at line 59 of file clip.cpp.

◆ contains()

template<int dim>

bool plask::Clip< dim >::contains ( const DVec & point ) const

overridevirtual

Check if this geometry object contains point.

Parameters

point point in local coordinates

Returns: true only if this geometry contains point p

Implements plask::GeometryObjectD< dim >.

Definition at line 32 of file clip.cpp.

◆ copyShallow() [1/2]

template<int dim>

shared_ptr< Clip< dim > > plask::Clip< dim >::copyShallow ( ) const

inline

Get shallow copy of this.

Returns: shallow copy of this

Definition at line 76 of file clip.hpp.

◆ copyShallow() [2/2]

template<int dim>

shared_ptr< Clip< dim > > plask::Clip< dim >::copyShallow ( const Box & new_clip ) const

inline

Get shallow copy of this with different clip box.

Parameters

new_clip clip box for new Clip object

Returns: shallow copy of this with clip box equal to new_clip

Definition at line 85 of file clip.hpp.

◆ fromChildCoords()

template<int dim>

Clip< dim >::Box plask::Clip< dim >::fromChildCoords ( const typename ChildType::Box & child_bbox ) const

overridevirtual

Convert bounding box from child's to this's coordinates.

Parameters

child_bbox bounding box of child

Returns: child_bbox converted to this's coordinates

Implements plask::GeometryObjectTransform< dim, Child_Type >.

Definition at line 45 of file clip.cpp.

◆ getMaterial()

template<int dim>

shared_ptr< Material > plask::Clip< dim >::getMaterial ( const DVec & p ) const

overridevirtual

Return material in a given point inside the geometry object.

Parameters

p point

Returns: material in given point, or nullptr if this GeometryObject not contains point p

Implements plask::GeometryObjectD< dim >.

Definition at line 28 of file clip.cpp.

◆ getPathsAt()

template<int dim>

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

overridevirtual

Find all paths to objects which lies at given point.

Parameters

point	a point in local coordinates
all	if true then return all paths if branches overlap the point

Returns: all paths, last one is on top and overlies the rest

Implements plask::GeometryObjectD< dim >.

Definition at line 37 of file clip.cpp.

◆ getPositionsToVec()

template<int dim>

void plask::Clip< dim >::getPositionsToVec	(	const GeometryObject::Predicate &	predicate,
		std::vector< DVec > &	dest,
		const PathHints *	path = `0`
	)		const

overridevirtual

Calculate and append to vector positions of all nodes which fulfill given predicate, optionally marked by path.

Some objects can have all vector of NaNs as translations. This mean that translation is not well defined (some space changer on path).

Parameters

predicate	predicate required to match
dest	place to add result, positions will be added in the same order which is generated by GeometryObject::getObjectsToVec
path	(optional) path hints which limits search space

Implements plask::GeometryObjectD< dim >.

Definition at line 50 of file clip.cpp.

◆ getTypeName()

template<int dim>

std::string plask::Clip< dim >::getTypeName ( ) const

inlineoverridevirtual

Get name of object type (like: "block2d", "shelf", "stack3d", etc.).

This name is used as tag name when object is serialized to XML.

Returns: name of object type

Implements plask::GeometryObject.

Definition at line 28 of file clip.hpp.

◆ shallowCopy()

template<int dim>

shared_ptr< GeometryObject > plask::Clip< dim >::shallowCopy ( ) const

overridevirtual

Get shallow copy of this.

In the shallow copy all children are the same

Returns: shallow copy of this

Implements plask::GeometryObject.

Definition at line 56 of file clip.cpp.

◆ writeXMLAttr() [1/5]

void plask::Clip< 2 >::writeXMLAttr	(	XMLWriter::Element &	dest_xml_object,
		const AxisNames &	axes
	)		const

protectedvirtual

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 166 of file clip.cpp.

◆ writeXMLAttr() [2/5]

void plask::Clip< 3 >::writeXMLAttr	(	XMLWriter::Element &	dest_xml_object,
		const AxisNames &	axes
	)		const

protectedvirtual

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 171 of file clip.cpp.

◆ writeXMLAttr() [3/5]

void plask::Clip< 2 >::writeXMLAttr	(	XMLWriter::Element &	dest_xml_object,
		const AxisNames &	axes
	)		const

protectedvirtual

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.

◆ writeXMLAttr() [4/5]

void plask::Clip< 3 >::writeXMLAttr	(	XMLWriter::Element &	dest_xml_object,
		const AxisNames &	axes
	)		const

protectedvirtual

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.

◆ writeXMLAttr() [5/5]

template<int dim>

void plask::Clip< dim >::writeXMLAttr	(	XMLWriter::Element &	dest_xml_object,
		const AxisNames &	axes
	)		const

overrideprotectedvirtual

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.

Member Data Documentation

◆ clipBox

template<int dim>

Box plask::Clip< dim >::clipBox

Clip box.

Definition at line 43 of file clip.hpp.

◆ NAME

template<int dim>

const char * plask::Clip< dim >::NAME = dim == 2 ? PLASK_CLIP2D_NAME : PLASK_CLIP3D_NAME

static

Definition at line 26 of file clip.hpp.

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

plask/geometry/clip.hpp
plask/geometry/clip.cpp

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Box

◆ ChildType

◆ DVec

Constructor & Destructor Documentation

◆ Clip() [1/2]

◆ Clip() [2/2]

Member Function Documentation

◆ addLineSegmentsToSet()

◆ addPointsAlongToSet()

◆ contains()

◆ copyShallow() [1/2]

◆ copyShallow() [2/2]

◆ fromChildCoords()

◆ getMaterial()

◆ getPathsAt()

◆ getPositionsToVec()

◆ getTypeName()

◆ shallowCopy()

◆ writeXMLAttr() [1/5]

◆ writeXMLAttr() [2/5]

◆ writeXMLAttr() [3/5]

◆ writeXMLAttr() [4/5]

◆ writeXMLAttr() [5/5]

Member Data Documentation

◆ clipBox

◆ NAME