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

Generates a topLeftClockWise or bottomLeftCounterClockWise (flipOnYAxis=true) spiral wipe: More...

#include <spiralwipe.hxx>

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

Public Member Functions

 SpiralWipe (sal_Int32 nElements, bool flipOnYAxis=false)
 
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...
 

Protected Member Functions

::basegfx::B2DPolyPolygon calcNegSpiral (double t) const
 

Protected Attributes

const sal_Int32 m_elements
 
const sal_Int32 m_sqrtElements
 
const bool m_flipOnYAxis
 

Detailed Description

Generates a topLeftClockWise or bottomLeftCounterClockWise (flipOnYAxis=true) spiral wipe:

Definition at line 30 of file spiralwipe.hxx.

Constructor & Destructor Documentation

◆ SpiralWipe()

slideshow::internal::SpiralWipe::SpiralWipe ( sal_Int32  nElements,
bool  flipOnYAxis = false 
)

Definition at line 32 of file spiralwipe.cxx.

References m_elements, and nElements.

Member Function Documentation

◆ calcNegSpiral()

basegfx::B2DPolyPolygon slideshow::internal::SpiralWipe::calcNegSpiral ( double  t) const
protected

◆ operator()()

basegfx::B2DPolyPolygon slideshow::internal::SpiralWipe::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.

Reimplemented in slideshow::internal::BoxSnakesWipe.

Definition at line 82 of file spiralwipe.cxx.

References basegfx::B2DPolyPolygon::append(), calcNegSpiral(), slideshow::internal::createUnitRect(), basegfx::B2DPolyPolygon::flip(), slideshow::internal::flipOnYAxis(), m_flipOnYAxis, and t.

Member Data Documentation

◆ m_elements

const sal_Int32 slideshow::internal::SpiralWipe::m_elements
protected

Definition at line 38 of file spiralwipe.hxx.

Referenced by calcNegSpiral().

◆ m_flipOnYAxis

const bool slideshow::internal::SpiralWipe::m_flipOnYAxis
protected

Definition at line 40 of file spiralwipe.hxx.

Referenced by operator()(), and slideshow::internal::BoxSnakesWipe::operator()().

◆ m_sqrtElements

const sal_Int32 slideshow::internal::SpiralWipe::m_sqrtElements
protected

Definition at line 39 of file spiralwipe.hxx.

Referenced by calcNegSpiral().


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