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

Generate a vertical left waterfall wipe. More...

#include <waterfallwipe.hxx>

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

Public Member Functions

 WaterfallWipe (sal_Int32 nElements, bool flipOnYAxis)
 
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

bool m_flipOnYAxis
 
::basegfx::B2DPolygon m_waterfall
 

Detailed Description

Generate a vertical left waterfall wipe.

Definition at line 30 of file waterfallwipe.hxx.

Constructor & Destructor Documentation

◆ WaterfallWipe()

slideshow::internal::WaterfallWipe::WaterfallWipe ( sal_Int32  nElements,
bool  flipOnYAxis 
)

Member Function Documentation

◆ operator()()

basegfx::B2DPolyPolygon slideshow::internal::WaterfallWipe::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 52 of file waterfallwipe.cxx.

References basegfx::B2DPolygon::count(), basegfx::utils::createTranslateB2DHomMatrix(), slideshow::internal::flipOnYAxis(), m_flipOnYAxis, m_waterfall, basegfx::B2DPolygon::setB2DPoint(), t, and basegfx::B2DPolygon::transform().

Member Data Documentation

◆ m_flipOnYAxis

bool slideshow::internal::WaterfallWipe::m_flipOnYAxis
private

Definition at line 36 of file waterfallwipe.hxx.

Referenced by operator()().

◆ m_waterfall

::basegfx::B2DPolygon slideshow::internal::WaterfallWipe::m_waterfall
private

Definition at line 37 of file waterfallwipe.hxx.

Referenced by operator()(), and WaterfallWipe().


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