LibreOffice Module slideshow (master) 1
Public Member Functions | Private Attributes | List of all members
slideshow::internal::FourBoxWipe Class Reference

Generate a 4-box wipe. More...

#include <fourboxwipe.hxx>

Inheritance diagram for slideshow::internal::FourBoxWipe:
[legend]
Collaboration diagram for slideshow::internal::FourBoxWipe:
[legend]

Public Member Functions

 FourBoxWipe (bool cornersOut)
 
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_cornersOut
 
const ::basegfx::B2DPolygon m_unitRect
 

Detailed Description

Generate a 4-box wipe.

Definition at line 31 of file fourboxwipe.hxx.

Constructor & Destructor Documentation

◆ FourBoxWipe()

slideshow::internal::FourBoxWipe::FourBoxWipe ( bool  cornersOut)
inlineexplicit

Definition at line 34 of file fourboxwipe.hxx.

Member Function Documentation

◆ operator()()

basegfx::B2DPolyPolygon slideshow::internal::FourBoxWipe::operator() ( double  t)
overridevirtual

Retrieve the poly-polygon for value t.

Parameters
tCurrent 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).

Implements slideshow::internal::ParametricPolyPolygon.

Definition at line 30 of file fourboxwipe.cxx.

References basegfx::B2DPolyPolygon::append(), basegfx::utils::createScaleTranslateB2DHomMatrix(), basegfx::utils::createTranslateB2DHomMatrix(), d, basegfx::B2DPolygon::flip(), m_cornersOut, m_unitRect, basegfx::B2DHomMatrix::scale(), square, t, basegfx::B2DPolygon::transform(), and basegfx::B2DPolyPolygon::transform().

Member Data Documentation

◆ m_cornersOut

const bool slideshow::internal::FourBoxWipe::m_cornersOut
private

Definition at line 39 of file fourboxwipe.hxx.

Referenced by operator()().

◆ m_unitRect

const ::basegfx::B2DPolygon slideshow::internal::FourBoxWipe::m_unitRect
private

Definition at line 40 of file fourboxwipe.hxx.

Referenced by operator()().


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