plask::edge::Mirror Struct Reference

#include <plask/geometry/edge.hpp>

Inheritance diagram for plask::edge::Mirror:

Collaboration diagram for plask::edge::Mirror:

Public Member Functions
Type	type () const override
void	applyLo (double bbox_lo, double bbox_hi, double &p, shared_ptr< Material > &result_material, const Strategy *opposite) const override
	Apply strategy to given point p.
void	applyHi (double bbox_lo, double bbox_hi, double &p, shared_ptr< Material > &result_material, const Strategy *opposite) const override
	Apply strategy to given point p.
bool	canMoveOutsideBoundingBox () const override
	Check if this strategy can move point p to place outside bounding box.
Mirror *	clone () const override
	Clone this strategy.
std::string	str () const override
	Get string representation of this strategy.
Public Member Functions inherited from plask::edge::Strategy
virtual	~Strategy ()

Additional Inherited Members
Public Types inherited from plask::edge::Strategy
enum	Type {   DEFAULT , SIMPLE , EXTEND , PERIODIC ,   MIRROR }
	Enum holding strategy types. More...
Static Public Member Functions inherited from plask::edge::Strategy
static Strategy *	fromStr (const std::string &str, const MaterialsDB &materialsDB=MaterialsDB::getDefault())
	Create new strategy (using operator new) described by string str.
static std::unique_ptr< Strategy >	fromStrUnique (const std::string &str, const MaterialsDB &materialsDB=MaterialsDB::getDefault())
	Create new strategy described by string str.

Detailed Description

Definition at line 201 of file edge.hpp.

Member Function Documentation

applyHi()

void plask::edge::Mirror::applyHi ( double  bbox_lo, double  bbox_hi, double &  p, shared_ptr< Material > &  result_material, const Strategy *  opposite  ) const

overridevirtual

Apply strategy to given point p.

Parameters

[in]	bbox_lo,bbox_hi	coordinates of geometry object bounding box in strategy working direction
[in,out]	p	coordinate of point in strategy working direction, it's (must be) higher than bbox_hi, this method can move this point
[out]	result_material	optionally, this method can assign to it material which should be used
[in]	opposite	strategy at opposite side (if known)

Implements plask::edge::Strategy.

Definition at line 120 of file edge.cpp.

applyLo()

void plask::edge::Mirror::applyLo ( double  bbox_lo, double  bbox_hi, double &  p, shared_ptr< Material > &  result_material, const Strategy *  opposite  ) const

overridevirtual

Apply strategy to given point p.

Parameters

[in]	bbox_lo,bbox_hi	coordinates of geometry object bounding box in strategy working direction
[in,out]	p	coordinate of point in strategy working direction, it's (must be) lower than bbox_lo, this method can move this point
[out]	result_material	optionally, this method can assign to it material which should be used
[in]	opposite	strategy at opposite side (if known)

Implements plask::edge::Strategy.

Definition at line 114 of file edge.cpp.

canMoveOutsideBoundingBox()

bool plask::edge::Mirror::canMoveOutsideBoundingBox ( ) const

overridevirtual

Check if this strategy can move point p to place outside bounding box.

Default implementation return false.

Returns

true if this strategy can move point p to place outside bounding box, false if this strategy always move point p to bounding box or doesn't move p at all

Reimplemented from plask::edge::Strategy.

Definition at line 127 of file edge.cpp.

clone()

Mirror * plask::edge::Mirror::clone ( ) const

overridevirtual

Clone this strategy.

Returns

strategy identical to this one, constructed using operator new

Implements plask::edge::Strategy.

Definition at line 131 of file edge.cpp.

str()

std::string plask::edge::Mirror::str ( ) const

overridevirtual

Get string representation of this strategy.

Returns

string representation of this strategy

Implements plask::edge::Strategy.

Definition at line 135 of file edge.cpp.

type()

Type plask::edge::Mirror::type ( ) const

inlineoverridevirtual

Returns

strategy type

Implements plask::edge::Strategy.

Definition at line 203 of file edge.hpp.

---

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

• plask/geometry/edge.hpp
• plask/geometry/edge.cpp