plask::align::details::PositionAlignerImpl< direction > Struct Template Reference

Alginer which place zero of object in constant, chosen place. More...

#include <plask/geometry/align.hpp>

Inheritance diagram for plask::align::details::PositionAlignerImpl< direction >:

Collaboration diagram for plask::align::details::PositionAlignerImpl< direction >:

Public Member Functions
	PositionAlignerImpl (double translation)
double	getAlign (double PLASK_UNUSED(low), double PLASK_UNUSED(hi)) const override
bool	useBounds () const override
	Check if this aligner getAlign use bounds (low and hi parameters) in calculation.
void	print (std::ostream &out) const override
	Print this to stream out.
std::string	key (const AxisNames &axis_names) const override
	Get aligner name.
Public Member Functions inherited from plask::align::AlignerImpl< direction >
	AlignerImpl (double coordinate)
	Construct new aligner.
virtual	~AlignerImpl ()
virtual double	getAlign (double low, double hi) const=0
	Get translation for aligned obiect.
double	align (Translation< 3 > &toAlign, const Box3D &childBoundingBox) const
	Set object coordinate in direction of aligner activity.
virtual double	align (Translation< 3 > &toAlign) const
	Set object translation in direction of aligner activity.
std::map< std::string, double >	asDict (const AxisNames &axis_names) const
	Get aligner as dictionary.
void	writeToXML (XMLElement &dest, const AxisNames &axis_names) const
	Write this aligner to XML.
Public Member Functions inherited from plask::Printable
virtual	~Printable ()
std::string	str () const
	Get string representation of this using print method.

Additional Inherited Members
Public Attributes inherited from plask::align::AlignerImpl< direction >
double	coordinate
	Coordinate to which this aligner aligns.
Static Public Attributes inherited from plask::align::AlignerImpl< direction >
static const Direction	direction
	Direction of activity.

Detailed Description

template<Direction direction>
struct plask::align::details::PositionAlignerImpl< direction >

Alginer which place zero of object in constant, chosen place.

Definition at line 292 of file align.hpp.

Constructor & Destructor Documentation

PositionAlignerImpl()

template<Direction direction>

plask::align::details::PositionAlignerImpl< direction >::PositionAlignerImpl ( double  translation )

inline

Definition at line 294 of file align.hpp.

Member Function Documentation

getAlign()

template<Direction direction>

double plask::align::details::PositionAlignerImpl< direction >::getAlign ( double   PLASK_UNUSEDlow, double   PLASK_UNUSEDhi  ) const

inlineoverride

Definition at line 296 of file align.hpp.

key()

template<Direction direction>

std::string plask::align::details::PositionAlignerImpl< direction >::key ( const AxisNames &  axis_names ) const

inlineoverridevirtual

Get aligner name.

Parameters

axis_names

name of axes

Returns

name of the aligner

Implements plask::align::AlignerImpl< direction >.

Definition at line 304 of file align.hpp.

print()

template<Direction direction>

void plask::align::details::PositionAlignerImpl< direction >::print ( std::ostream &  out ) const

inlineoverridevirtual

Print this to stream out.

Parameters

out	print destination, output stream

Implements plask::Printable.

Definition at line 302 of file align.hpp.

useBounds()

template<Direction direction>

bool plask::align::details::PositionAlignerImpl< direction >::useBounds ( ) const

inlineoverridevirtual

Check if this aligner getAlign use bounds (low and hi parameters) in calculation.

Returns

true only if this aligner use bounds, false if bounds are ignored

Reimplemented from plask::align::AlignerImpl< direction >.

Definition at line 300 of file align.hpp.

---

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

• plask/geometry/align.hpp