Generates a default topleft to right bottom box wipe. More...

#include <boxwipe.hxx>

Inheritance diagram for slideshow::internal::BoxWipe:

Collaboration diagram for slideshow::internal::BoxWipe:

Public Member Functions
	BoxWipe (bool topCentered)

virtual ::basegfx::B2DPolyPolygon	operator() (double t) override
	Retrieve the poly-polygon for value t. More...

Public Member Functions inherited from slideshow::internal::ParametricPolyPolygon
virtual	~ParametricPolyPolygon ()

virtual ::basegfx::B2DPolyPolygon	operator() (double t)=0
	Retrieve the poly-polygon for value t. More...

Private Attributes
const bool	m_topCentered

const ::basegfx::B2DPolyPolygon	m_unitRect

Detailed Description

Generates a default topleft to right bottom box wipe.

Definition at line 30 of file boxwipe.hxx.

Constructor & Destructor Documentation

slideshow::internal::BoxWipe::BoxWipe ( bool topCentered )

inlineexplicit

Definition at line 33 of file boxwipe.hxx.

basegfx::B2DPolyPolygon slideshow::internal::BoxWipe::operator() ( double t )

overridevirtual

Retrieve the poly-polygon for value t.

Parameters

t	Current parameter value to retrieve the corresponding poly-polygon for. Permissible values for t must be in the range [0,1].

Returns: a poly-polygon corresponding to the given parameter value. The poly-polygon is interpreted as living in the unit rectangle (i.e. [0,1]x[0,1]), but is not necessarily constrained to completely lie in this area (this very much depends on the actual effect to be generated). Although, from a performance perspective, it currently is advantageous to try to keep the poly-polygon within these bounds (at least if there are no hard reasons not to do so), because then reversion or out transformations are potentially faster to compute (see the TransitionInfo::meReverseMethod member in transitionfactory.cxx). Furthermore, if one of the polygon modifications involve subtraction (also see TransitionInfo::meReverseMethod), all generated polygons should be oriented clock-wise (i.e. traversing the polygon vertices with increasing vertex index should generate a clock-wise movement).

Definition at line 27 of file boxwipe.cxx.

const bool slideshow::internal::BoxWipe::m_topCentered

private

Definition at line 38 of file boxwipe.hxx.

Referenced by operator()().

const ::basegfx::B2DPolyPolygon slideshow::internal::BoxWipe::m_unitRect

private

Definition at line 39 of file boxwipe.hxx.

Referenced by operator()().

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